---
title: "candidateTag.list"
method: POST
path: "/candidateTag.list"
tags: ["Candidate Tag"]
---

# candidateTag.list

`POST /candidateTag.list`

Lists all candidate tags.

See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.

**Requires the [`hiringProcessMetadataRead`](authentication#permissions-candidatetaglist) permission.**

## Request body

- CandidateTagListRequest
  - `includeArchived` boolean, nullable — Whether archived candidate tags should be included in the response
  - `cursor` string, nullable — The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.
  - `limit` integer, nullable — The maximum number of candidate tags to return per page. Maximum is 100.
  - `syncToken` string, nullable — A sync token to retrieve only candidate tags updated since the last sync. Obtained from a previous list response.

## Response `200`

Responses from the candidateTag.list endpoint

- union
  - CandidateTagListSuccessResponse
    - `success` true, required
    - `results` CandidateTag[], required
      - `id` string, uuid, required — The candidate tag's unique identifier
      - `title` string, required — The tag's title
      - `isArchived` boolean, required — Whether the tag has been archived
    - `nextCursor` string — Cursor for the next page of results, if available
    - `moreDataAvailable` boolean — Whether more data is available beyond this page
    - `syncToken` string — Sync token to use for future incremental syncs. Only present on the last page.
  - ErrorResponse
    - `success` false, required
    - `errors` ErrorDetail[], required
      - `message` string, required
      - `parameter` string

---

[API](https://skmtc.dev/ashbyhq/apis/ashby-api.md) · [All operations](https://skmtc.dev/ashbyhq/apis/ashby-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ashbyhq/ashby-api/revisions/778b919dc743/schema)