GET
/
reports
curl --request GET \
  --url https://api.apriora.ai/v1/api/reports \
  --header 'X-API-Key: <api-key>'
[
  {
    "reportId": "reportId",
    "candidateId": "candidateId",
    "positionId": "positonId",
    "overallScore": 85,
    "overallFeedback": "The candidate performed well overall.",
    "questionSummary": [
      {
        "question": "What is your favorite color?",
        "summary": "The candidate's favorite color is blue."
      }
    ],
    "tags": [
      {
        "name": "Work Authorization",
        "value": "Yes",
        "evidence": "The candidate confirmed they are authorized to work in the United States"
      }
    ],
    "skills": [
      {
        "name": "Communication",
        "score": 85,
        "feedback": "The candidate communicated clearly and effectively."
      }
    ],
    "timeCompleted": 1620000000,
    "videoUrl": "https://example.com/video.mp4",
    "pdfUrl": "https://example.com/report.pdf"
  }
]
At least one query parameter is required.

Authorizations

X-API-Key
string
header
required

Query Parameters

reportId
string

The id of the report to filter by. If this is provided, all other filters will be ignored.

positionId
string

The id of the position to filter by

candidateId
string

The id of the candidate to filter by

Response

200
application/json

Reports response

The response is of type object[].