Docs
API reference

List a job's final rounds

GET
/api/v1/jobs/{jobId}/final-rounds

One summary per final round prepared for the job's reports, newest first: status, how many interviewers there are and how many have submitted, and how the submitted scorecards lean. Lean counts follow the scorecard visibility rule for the key's owner: they are null while the owner is an interviewer on that final round who has not submitted their own scorecard. Drafts are never counted. For per-requirement panel ratings, notes and who gave them, retrieve a final round's scorecards with GET /v1/reports/{id}/final-round/scorecards. Answers job_not_found for a job outside your organization.

Required scope: reports:read (reports:write also works).

Errors

  • 400: invalid_cursor, unknown_field
  • 401: authentication_required, invalid_api_key
  • 403: api_access_disabled, insufficient_scope
  • 404: job_not_found
  • 422: invalid_parameter
  • 429: rate_limit_exceeded
  • 500: api_error
  • 503: service_unavailable

Authorization

ApiKey
headerAuthorizationBearer <probb_live_<id>_<secret>>

Path Parameters

jobId*string

The job's ID.

Length1 <= length <= 200

Query Parameters

limit?integer

Page size, 1 to 100. Defaults to 25.

Range1 <= value <= 100
Default25
cursor?string

The nextCursor from the previous page.

Length1 <= length <= 2048

Response Body

Success.

application/json
  1. response
object*string
data*array<>

The final rounds on this page.

hasMore*boolean

Whether another page follows.

nextCursor*|

Pass as cursor to fetch the next page, or null at the end.

Example Request
# 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/jobs/JOB_ID_VALUE/final-rounds" \  -H "Authorization: Bearer $PROBB_API_KEY"
Example Response
{  "object": "list",  "data": [    {      "object": "final_round_summary",      "finalRoundId": "string",      "reportId": "string",      "candidate": {        "id": "string",        "name": "string"      },      "status": "active",      "itemCount": -9007199254740991,      "interviewerCount": -9007199254740991,      "submittedCount": -9007199254740991,      "locked": true,      "leans": {        "strong_yes": -9007199254740991,        "yes": -9007199254740991,        "no": -9007199254740991,        "strong_no": -9007199254740991      },      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "hasMore": true,  "nextCursor": "string"}