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

# List custom fields

`GET /custom_fields`

List and filter custom fields.

## Query parameters

- `limit` integer
- `starting_after` string, uuid
- `sort_order` 'asc' | 'desc'
- `start_date` string, date
- `end_date` string, date
- `key` string
- `object_type` string[]
- `type` 'select' | 'text'

## Response `200`

200

- CustomFieldSearchResult
  - `records` CustomFieldDetails[]
    - `key` string, required — The key of the custom field.
    - `name` string, required — The name of the custom field.
    - `type` 'select' | 'text', required — The type of the custom field.
    - `object_types` string[], required — The types of object this custom field can be applied to.
    - `values` CustomFieldValuesCreation[], required — List of values the custom field can take. Only applicable to custom fields with `select` type.
      - `key` string, required — The key of the value. Must be unique in the custom field and `snake_case`.
      - `name` string, required — The name of the value.
    - `created_at` string, date-time, required — The UTC timestamp of the creation of the custom field.

## Other responses

- `400` — Validation error.

---

[API](https://skmtc.net/numeral/apis/payments.md) · [All operations](https://skmtc.net/numeral/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/numeral/payments/revisions/220f101cc2ef/schema)