API reference
Preview a final round
GET
The requirements a final round for this report could cover, in the order the panel asks them, each marked open when nothing shows it yet or something argues against it. Use the keys with PUT /v1/reports/{id}/final-round. Changes nothing.
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*stringreportId*stringsupported*booleanFalse when a final round cannot be prepared from this report.
reason*|Why not, when supported is false.
requirements*array<>In the order the panel asks them: must-have first.
otherQuestions*array<string>Questions the report suggests that belong to no requirement.
finalRoundId*|The report's final round, if one exists.
jobOpen*booleanFalse when the job is closed: reopen it before preparing.
# 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/final-round/preview" \ -H "Authorization: Bearer $PROBB_API_KEY"Example Response
{ "object": "final_round_preview", "reportId": "string", "supported": true, "reason": "legacy_version", "requirements": [ { "key": "string", "label": "string", "priority": "must_have", "hardConstraint": true, "resume": { "state": "shown", "summary": "string" }, "interview": { "state": "shown", "summary": "string" }, "followUpRecommended": true, "guidance": "string", "probes": [ "string" ], "open": true } ], "otherQuestions": [ "string" ], "finalRoundId": "string", "jobOpen": true}