Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Interview Plan

interviewPlan.list

List published interview plans. Draft interview plans are not returned. If includeArchived is true, archived interview plans are also included. Job-specific interview plans are only returned when the caller can read the associated job.

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

Requires the interviewsRead permission.

post/interviewPlan.list

Request body

includeArchivedboolean nullable

Whether archived interview plans should be included in the response

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 interview plans to return per page. Maximum is 100.

syncTokenstring nullable

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

Example request

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

Response

Responses from the interviewPlan.list endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "3ae2b801-19f6-41ef-ad28-214bd731948f",
      "title": "Engineering Interview Plan",
      "isArchived": false,
      "createdAt": "2022-08-12T20:29:56.964Z",
      "updatedAt": "2023-09-13T21:30:57.965Z"
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}