v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Interviewer Pool

interviewerPool.list

List all interviewer pools.

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

Requires the hiringProcessMetadataRead permission.

post/interviewerPool.list

Request body

cursorstring nullable

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

syncTokenstring nullable

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

limitnumber nullable

The maximum number of interviewer pools to return per page.

includeArchivedPoolsboolean nullable

When true, includes archived pools. Defaults to false.

includeArchivedTrainingStagesboolean nullable

When true, includes archived training stages. Defaults to true.

Example request

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

Response

Responses from the interviewerPool.list endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "2d8bb563-9ca2-47cd-a41c-d82dc0688508",
      "title": "Zod Create QA 2026-04-24 0035",
      "isArchived": false,
      "trainingPath": {
        "id": "99a059b6-121b-4e91-877d-720d4a12585a",
        "enabled": true,
        "trainingStages": [
          {
            "id": "8182b3d8-e224-4c4f-8827-ed96cd860878",
            "interviewerRole": "Shadow",
            "interviewsRequired": 1,
            "isArchived": false,
            "approvalRequired": false,
            "approvers": null
          },
          {
            "id": "037b5ae3-8901-4380-99f7-ac403d494d7f",
            "interviewerRole": "ReverseShadow",
            "interviewsRequired": 1,
            "isArchived": false,
            "approvalRequired": false,
            "approvers": null
          }
        ]
      }
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}