v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Application

application.listCriteriaEvaluations

Fetch a paginated list of AI criteria evaluations for an application.

This endpoint returns the AI-generated criteria evaluations that assess how well a candidate meets specific job requirements. Each evaluation contains the outcome, reasoning, and other assessment details.

This endpoint supports pagination only (not incremental sync). See the Pagination and Incremental Synchronization guide for usage examples.

Note: This endpoint requires the AI Application Review feature to be enabled for your organization.

Requires the candidatesRead permission.

post/application.listCriteriaEvaluations

Request body

applicationIdstring uuid required

The id of the application to fetch criteria evaluations for.

cursorstring nullable

The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.

limitnumber nullable

The maximum number of criteria evaluations to return per page.

Example request

{
  "applicationId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "cursor": "G8",
  "limit": 25
}

Response

Responses from the application.listCriteriaEvaluations endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "a4d6d2f0-9b8f-4f0a-8b1a-1f6f7d3c2d1e",
      "criterion": {
        "id": "9b2cb8d9-1a6b-4d4f-9c5d-69ef7b9a9f12",
        "title": "Location",
        "type": "ResumePrompt",
        "prompt": "Evaluate if the candidate's location aligns with the job requirements.",
        "applicationFormDefinitionId": null,
        "applicationFormFieldPath": null
      },
      "status": "Completed",
      "outcome": "Meets",
      "reasoning": "The candidate's location in San Francisco aligns well with the job's requirement for Bay Area presence.",
      "skipReason": null,
      "outcomeNumber": 0.85,
      "evaluatedAt": "2024-01-15T10:30:00.000Z"
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}