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

# List all custom fields

`GET /v1/custom-fields`

Lists all custom fields

## Query parameters

- `cursor` integer
- `limit` integer

## Response `200`

Successful Response

- ExternalApiListResponseExternalCustomField
  - `data` ExternalCustomField[], required
    - `updatedAt` string, date-time, nullable
    - `createdAt` string, date-time, nullable
    - `key` string, nullable
    - `companyId` string, uuid, nullable
    - `displayName` string, nullable
    - `description` string, nullable
    - `category` 'account' | 'customer' | 'ticket'
    - `fieldMetadata` string[], nullable
    - `dynamicFieldMetadata` object, nullable
    - `type` 'Text' | 'Number' | 'Decimal' | 'Boolean' | 'Date' | 'List' | 'MultiSelect' | 'Agent' | 'Customer' | 'Ticket' | 'Account' | 'URL' | 'Address' | 'DynamicList' | 'DynamicMultiSelect'
    - `required` boolean, nullable
    - `editableBy` EditableBy[], nullable
    - `active` boolean, nullable
    - `rules` CustomFieldRule[], nullable
      - `conditions` object, required
      - `actions` object, required
    - `dependsOn` string[], nullable
    - `defaultValue` union
      - string
      - integer
      - number
      - boolean
      - string, date
      - string[]
      - object
    - `id` string, uuid, nullable
  - `total` integer, nullable
  - `cursor` integer, nullable
  - `limit` integer, nullable

## Other responses

- `422` — Validation Error

---

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