---
title: "List custom fields"
method: GET
path: "/api/custom-fields"
tags: ["Custom Fields"]
---

# List custom fields

`GET /api/custom-fields`

List custom fields matching the given parameters, paginated, and ordered.

## Query parameters

- `object_type` 'Ticket' | 'Customer', required
- `search` string
- `archived` boolean
- `order_by` 'priority:asc' | 'priority:desc'
- `cursor` string
- `limit` integer

## Response `200`

List of custom fields according to the given criteria.

- object
  - `object` string, required
  - `uri` string, required
  - `data` CustomField[], required
    - `id` integer, required — ID of the custom field.
    - `external_id` string — ID of the custom field in a foreign system (ex: Zendesk).
    - `object_type` 'Ticket' | 'Customer', required
    - `label` string, required — The name of the custom field.
    - `description` string — The description of the custom field.
    - `priority` integer, required — Order in which custom fields are displayed.
    - `required` boolean, required — Whether this custom field is required.
    - `managed_type` union — The type of the managed field.
      - 'contact_reason' | 'product' | 'resolution' | 'ai_intent' | 'ai_outcome' | 'ai_sales' | 'ai_discount' | 'ai_journey' | 'managed_sentiment' | 'call_status'
      - 'customer_type'
    - `definition` union, required — The settings for this custom field, dependent on the data type.
      - TextDataTypeDefinition
        - `data_type` 'text', required
        - `input_settings` union, required — The input settings for this custom field, dependent on the input type.
          - TextInputSettings
            - `input_type` 'input', required
            - `placeholder` string — A hint to show within the input field when no data is entered.
          - DropdownInputSettingsSettings
            - `input_type` 'dropdown', required
            - `choices` string[], required — The available choices to show in the dropdown.
            - `default` string — The default value for this dropdown.
      - NumberDataTypeDefinition
        - `data_type` 'number', required
        - `input_settings` NumberInputSettings, required
          - `input_type` 'input_number', required
          - `placeholder` string — A hint to show within the input field when no data is entered.
          - `min` union — Minimum allowed number as value.
            - number
            - string
          - `max` union — Maximum allowed number as value.
            - number
            - string
      - BooleanDataTypeDefinition
        - `data_type` 'boolean', required
        - `input_settings` BooleanDropdownInputSettings, required
          - `input_type` 'dropdown', required
          - `choices` boolean[] — The boolean choices to show as a dropdown.
          - `default` boolean — The default value.
    - `created_datetime` string, date-time, required — When the custom field was created.
    - `updated_datetime` string, date-time, required — When the custom field was last updated.
    - `deactivated_datetime` string, date-time — When the custom field was deactivated.
  - `meta` CursorPaginationMeta, required
    - `prev_cursor` string, required
    - `next_cursor` string, required
    - `total_resources` integer, required

---

[API](https://skmtc.net/gorgias/apis/gorgias-rest-api.md) · [All operations](https://skmtc.net/gorgias/apis/gorgias-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gorgias/gorgias-rest-api/versions/36f2e31f4e81/schema)