Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Candidate Tag

candidateTag.list

Lists all candidate tags.

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

Requires the hiringProcessMetadataRead permission.

post/candidateTag.list

Request body

includeArchivedboolean nullable

Whether archived candidate tags 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 candidate tags to return per page. Maximum is 100.

syncTokenstring nullable

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

Example request

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

Response

Responses from the candidateTag.list endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "title": "Strong candidate",
      "isArchived": false
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}