---
title: "customField.list"
method: POST
path: "/customField.list"
tags: ["Custom Field"]
---

# customField.list

`POST /customField.list`

Lists all custom fields.

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

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

## Request body

- CustomFieldListRequest
  - `cursor` string, nullable — The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.
  - `syncToken` string, nullable — A sync token to retrieve only custom fields updated since the last sync. Obtained from a previous list response.
  - `limit` integer, nullable — The maximum number of items to return. The maximum and default value is 100.
  - `includeArchived` boolean, nullable — If true, archived custom fields will be included in the response

## Response `200`

Responses from the customField.list endpoint

- union
  - CustomFieldListSuccessResponse
    - `success` true, required
    - `results` CustomFieldDefinition[], required
      - `id` string, required — The custom field's unique identifier
      - `title` string, required — The custom field's title
      - `description` string, nullable, required — A description of the custom field
      - `objectType` string, required — The type of object the field is associated with
      - `isArchived` boolean, required — Whether the custom field is archived
      - `isPrivate` boolean, required — Whether the custom field is private
      - `fieldType` string, required — The custom field's field type
      - `isRequired` boolean, required — Whether the custom field is required
      - `selectableValues` CustomFieldSelectableValue[] — Selectable values for ValueSelect and MultiValueSelect custom fields
        - `label` string, required — The display label for the selectable value
        - `value` string, required — The API value for the selectable value
        - `isArchived` boolean, required — Whether the selectable value is 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.net/ashbyhq/apis/ashby-api.md) · [All operations](https://skmtc.net/ashbyhq/apis/ashby-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ashbyhq/ashby-api/revisions/778b919dc743/schema)