API reference
List a report's suggested questions
GET
The questions Probb suggests asking the candidate (the screening call guide, or the hiring-manager follow-ups for older reports), in the order the report shows them, with whether the team has already asked each one. Empty until the report has completed. Tick a question off with PUT /v1/reports/{id}/follow-ups/{followUpId}/asked.
Required scope: reports:read (reports:write also works).
Errors
- 400:
unknown_field - 401:
authentication_required,invalid_api_key - 403:
api_access_disabled,insufficient_scope - 404:
report_not_found - 422:
invalid_parameter - 429:
rate_limit_exceeded - 500:
api_error - 503:
service_unavailable
ApiKeyheader
AuthorizationBearer <probb_live_<id>_<secret>>id*stringThe report's ID.
Length
1 <= length <= 200Success.
application/json- response
object*stringdata*array<>The questions on this page.
hasMore*booleanWhether another page follows.
nextCursor*|Pass as cursor to fetch the next page, or null at the end.
# Set PROBB_URL and PROBB_API_KEY. Replace any *_VALUE placeholder and any example ID (such as job_example) with a real one.curl --fail-with-body -X GET "$PROBB_URL/api/v1/reports/ID_VALUE/follow-ups" \ -H "Authorization: Bearer $PROBB_API_KEY"Example Response
{ "object": "list", "data": [ { "object": "follow_up", "id": "string", "reportId": "string", "group": "string", "question": "string", "asked": true, "askedAt": "2019-08-24T14:15:22Z", "askedBy": { "id": "string", "name": "string" } } ], "hasMore": true, "nextCursor": "string"}