---
title: "List custom field definitions"
method: GET
path: "/custom-fields"
tags: ["Custom fields"]
---

# List custom field definitions

`GET /custom-fields`

## Request

- Base URL: `https://there-there.app/api`
- URL: `https://there-there.app/api/custom-fields`
- Auth: HTTP bearer

Every ticket custom field defined in the workspace, with its options. This is where an integration resolves a field or option name to the ulid the ticket endpoints expect. Read only: fields are defined in the app.

## Headers

- `X-Workspace-Id` integer

## Response `200`

Custom field definitions

- object
  - `data` CustomFieldDefinition[]
    - `ulid` string
    - `name` string
    - `type` 'text' | 'single_select' | 'multi_select'
    - `all_channels` boolean: When true the field applies to every channel and channel_ulids is empty.
    - `channel_ulids` string[]
    - `options` TicketCustomFieldOption[]
      - `ulid` string
      - `name` string
      - `color` string, nullable
      - `icon` string, nullable

---

[API](https://skmtc.dev/there-there/apis/there-there-api.md) · [All operations](https://skmtc.dev/there-there/apis/there-there-api/llms.txt) · [OpenAPI document](https://skmtc.dev/there-there/apis/there-there-api/revisions/1811fb0febc1?raw)