Docs
API reference

Get a report summary

GET
/api/v1/reports/{id}

Read candidate and job context with a compact resume-analysis result. Use this for an application overview; use the detailed result endpoint for rubric evidence.

Before you call

Use a reportId from preparation, admission, list results, or a report event. Add include=reference to include your external application reference.

Required scope: reports:read.

What happens next

Inspect status before reading result. A null result is not a zero score. Use Get report status for polling or Get report result for the full public evaluation.

Recovery

A 404 means the report is unavailable to this workspace or was removed. requires_action needs a human review in the app. Do not repeatedly resubmit to bypass that review.

Follow the complete workflow · Errors and retries

Authorization

ApiKey
headerAuthorizationBearer <token>

Path Parameters

id*string

Resource ID returned by this resource's creation or list endpoint. See prerequisites for whether this is a report, interview, job, or batch ID.

Length1 <= length <= 100

Query Parameters

include?"reference"

Set to reference to include externalReference in report summaries; omitted by default for compatibility.

Value in"reference"

Response Body

Inspect status before reading result. A null result is not a zero score. Use Get report status for polling or Get report result for the full public evaluation.

application/json
  1. response
data*
# Set PROBB_URL and PROBB_API_KEY. Replace RESOURCE_ID if present.curl --fail-with-body -X GET "$PROBB_URL/api/v1/reports/RESOURCE_ID" \  -H "Authorization: Bearer $PROBB_API_KEY"
{  "data": {    "id": "report_example",    "createdAt": "2026-09-29T12:00:00.000Z",    "reportSystemVersion": "assigned-report-version",    "status": "completed",    "attemptId": "attempt_example",    "code": null,    "jobDescription": {      "id": "job_example",      "title": "Backend Engineer",      "company": "Example Company"    },    "candidate": {      "name": "Alex Example",      "currentRole": "Software Engineer"    },    "result": {      "score": 8,      "summary": "Relevant backend delivery experience; validate incident response depth.",      "scoreReasoning": "Strong API and database evidence, with limited detail on production incidents."    }  }}