---
title: "List Custom Fields"
method: GET
path: "/custom_fields"
tags: ["Custom Fields"]
---

# List Custom Fields

`GET /custom_fields`

## Request

- Base URL: `https://api.upflow.io/v1`
- URL: `https://api.upflow.io/v1/custom_fields`
- Auth: API key in header `X-Api-Key` and API key in header `X-Api-Secret`

List custom fields with optional pagination.

## Query parameters

- `offset` integer
- `page` integer
- `limit` integer

## Response `200`

Paginated list of custom fields.

- object
  - `offset` integer: 0-based index of the first item returned. Returned when using offset-based pagination or by default.
  - `page` integer: Page number (1-based). Returned when using page-based pagination.
  - `limit` integer, required: Maximum number of items returned.
  - `total` integer, required: Total items in the set.
  - `items` CustomField[], required
    - `externalId` string, required: Custom field external identifier.
    - `label` string, required: Custom field label displayed in the UI.
    - `description` string, nullable: Custom field description.
    - `dataType` 'STRING' | 'BOOLEAN' | 'FLOAT' | 'DATE' | 'DATETIME' | 'SELECT' | 'MULTI_SELECT', required: Data type of the custom field.
    - `entityType` 'CUSTOMER' | 'INVOICE' | 'CONTACT', required: The type of entity the custom field applies to.
    - `id` string, uuid, required: The Custom Field ID.
    - `source` string, nullable: Source of the custom field definition.

---

[API](https://skmtc.dev/upflow/apis/upflow-api.md) - [All operations](https://skmtc.dev/upflow/apis/upflow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upflow/apis/upflow-api/revisions/898a98ca0587?raw)