References
List report references
Scope: reports:read
Every reference questionnaire attached to the report, with its delivery and response state.
AuthorizationBearer <token>
Use Authorization: Bearer vrf_live_... or vrf_test_....
In: header
Path Parameters
reportId*string
Report identifier.
Format
uuidQuery Parameters
page?integer
Zero-based page number. The first page is 0.
Range
0 <= valueDefault
0size?integer
Records per page. Large values are capped.
Range
1 <= value <= 200Default
20sortBy?string
Sort key. An unsupported key falls back to the endpoint's default order.
sortDirection?string
Sort direction.
Default
"asc"Value in
- "asc"
- "desc"
Response Body
application/json
curl -X GET "https://example.com/api/v1/reports/497f6eca-6276-4993-bfeb-53cbbbba6f08/references?page=0&size=20&sortBy=createdAt"{ "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "reportId": "836df459-dc40-4aa1-972a-6eb0a864dff9", "refereeName": "string", "refereeEmail": "user@example.com", "refereePhone": "string", "status": "REQUESTED", "sentAt": "2019-08-24T14:15:22Z", "submittedAt": "2019-08-24T14:15:22Z", "responses": {} } ], "page": 0, "size": 20, "totalItems": 42, "totalPages": 3, "hasNext": true, "hasPrevious": true}