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

# List custom field definitions

`GET /custom_field_definitions`

## Query parameters

- `page[number]` integer
- `page[size]` integer
- `filter[entity_type]` string
- `filter[data_type]` string
- `filter[display_name]` string

## Response `200`

OK

- object
  - `data` CustomFieldDefinition[]
    - `id` string, uuid, required
    - `type` 'custom_field_definition', required
    - `attributes` object
      - `entity_type` 'Shipment' | 'Container' | 'TrackingRequest', required
      - `api_slug` string, required
      - `display_name` string, required
      - `description` string, nullable
      - `data_type` 'short_text' | 'number' | 'date' | 'datetime' | 'boolean' | 'enum' | 'enum_multi' | 'reference', required
      - `reference_type` string, nullable
      - `validation` object, nullable
      - `default_format` string, nullable
      - `default_value` union — Raw custom field value (type depends on definition)
        - string
        - number
        - boolean
        - string[]
        - object
  - `links` Links
    - `last` string, uri
    - `next` string, uri
    - `prev` string, uri
    - `first` string, uri
    - `self` string, uri
  - `meta` Meta
    - `size` integer
    - `total` integer

---

[API](https://skmtc.dev/terminal49/apis/terminal49-api-reference.md) · [All operations](https://skmtc.dev/terminal49/apis/terminal49-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/terminal49/terminal49-api-reference/revisions/998a27e39c03/schema)