Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Interview Schedule

interviewSchedule.list

Gets all interview schedules in the organization.

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

Requires the interviewsRead permission.

post/interviewSchedule.list

Request body

applicationIdstring uuid nullable

The id of the application, for which to fetch interview schedules

interviewStageIdstring uuid nullable

The id of the interview stage, for which to fetch interview schedules

createdAfternumber nullable

The API will return data after this date, which is the time since the unix epoch in milliseconds

cursorstring nullable

Opaque cursor indicating which page of results to fetch

syncTokenstring nullable

An opaque token representing the last time the data was successfully synced from the API. A new, updated one is returned after successfully fetching the last page of data.

limitnumber nullable

The maximum number of items to return. The maximum and default value is 100.

Example request

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

Response

Responses from the interviewSchedule.list endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "status": "Cancelled",
      "applicationId": "7211e226-7802-41fd-8d55-2720fe9d534f",
      "interviewStageId": "c153b3e9-8b97-4fc0-bad1-6c654122c1f8",
      "scheduledBy": null,
      "createdAt": "2026-04-25T02:46:41.817Z",
      "updatedAt": "2026-04-25T02:46:46.230Z",
      "interviewEvents": []
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}