Reports

Get a report summary

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

get/api/v1/reports/{id}

Request

  • Base URL: https://app.probbai.com
  • URL: https://app.probbai.com/api/v1/reports/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

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

Query parameters

include'reference'

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

Response

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.

Changes

No recorded changes to this operation across all 1 revision of this API.