Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Interview

interview.list

List all interviews.

See the Pagination and Incremental Synchronization guide for detailed usage examples.

Requires the interviewsRead permission.

post/interview.list

Request body

includeArchivedboolean nullable

When true, includes archived interviews in the response. Defaults to false.

includeNonSharedInterviewsboolean nullable

If true, interviews that are associated with specific jobs will be included in the response. Shared interviews that are not associated with a specific job can be scheduled for applications to any job. Interviews that are not shared can only be scheduled for applications to the job they are associated with. Defaults to false.

excludeArchivedScheduleTemplateInterviewsboolean nullable

If true, interviews local to archived schedule templates are omitted from the response. This parameter only has an effect when includeNonSharedInterviews is also set to true. Shared interviews (not associated with any schedule template) are always included regardless of this setting. Defaults to false.

cursorstring nullable

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

limitinteger nullable

The maximum number of interviews to return per page. Maximum is 100.

syncTokenstring nullable

A sync token to retrieve only interviews updated since the last sync. Obtained from a previous list response.

Example request

{
  "cursor": "G8",
  "limit": 25,
  "syncToken": "jYnEBmjzR"
}

Response

Responses from the interview.list endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "title": "Technical Interview",
      "externalTitle": "Technical Interview",
      "type": "Interview",
      "isArchived": false,
      "isDebrief": false,
      "isFeedbackRequired": true,
      "isFeedbackRequested": true,
      "instructionsHtml": "<p>Use the scorecard to evaluate the candidate.</p>",
      "instructionsPlain": "Use the scorecard to evaluate the candidate.",
      "jobId": "2cb69137-763a-4d6f-8f17-bbc3564ecb2e",
      "feedbackFormDefinitionId": "07189c2e-cacd-489d-8946-165acacc386f"
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}