Docs
API reference

Retrieve a final round's scorecards

GET
/api/v1/reports/{id}/final-round/scorecards

The panel's scorecards as the key's owner may see them. Everyone on the panel is listed with whether they have submitted; an outside interviewer has kind external, and their scorecard follows the same visibility rule as a member's. The owner's own scorecard is always included, draft or submitted. Other interviewers' scorecards are included only once submitted, and only if the owner is not an interviewer on this final round who has yet to submit their own (othersHidden is then true). Drafts are never shown to anyone but their author. Answers final_round_not_found when none has been prepared.

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

Errors

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

Authorization

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

Path Parameters

id*string

The report's ID.

Length1 <= length <= 200

Response Body

Success.

application/json
  1. response
object*string
reportId*string
finalRoundId*string
status*string
Value in"active""completed""cancelled"
othersHidden*boolean

True while you are an interviewer on this final round and have not submitted your own scorecard: you then see only yours, and for the others only whether they have submitted.

interviewers*array<>

Everyone on the panel and whether they have submitted. Visible to every member whatever else is hidden.

scorecards*array<>

Your own scorecard (draft or submitted) and the submitted scorecards you may read. Drafts of other interviewers are never listed.

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/reports/ID_VALUE/final-round/scorecards" \  -H "Authorization: Bearer $PROBB_API_KEY"
Example Response
{  "object": "final_round_scorecards",  "reportId": "string",  "finalRoundId": "string",  "status": "active",  "othersHidden": true,  "interviewers": [    {      "assignmentId": "string",      "kind": "member",      "user": {        "id": "string",        "name": "string"      },      "submitted": true,      "itemCount": -9007199254740991,      "isYou": true    }  ],  "scorecards": [    {      "object": "final_round_scorecard",      "id": "string",      "finalRoundId": "string",      "reportId": "string",      "interviewer": {        "id": "string",        "name": "string",        "kind": "member"      },      "status": "draft",      "lean": "strong_yes",      "summaryNote": "string",      "revision": -9007199254740991,      "submittedAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "entries": [        {          "key": "string",          "kind": "requirement",          "label": "string",          "rating": "shown",          "note": "string"        }      ]    }  ]}