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

# List Custom Fields

`GET /v1/custom-fields/`

List custom fields.

**Scopes**: `custom_fields:read` `custom_fields:write`

## Query parameters

- `organization_id` union — Filter by organization ID.
  - string, uuid4 — The organization ID.
  - string[]
- `query` string, nullable — Filter by custom field name or slug.
- `type` union — Filter by custom field type.
  - 'text' | 'number' | 'date' | 'checkbox' | 'select'
  - CustomFieldType[]
- `page` integer — Page number, defaults to 1.
- `limit` integer — Size of a page, defaults to 10. Maximum is 100.
- `sorting` CustomFieldSortProperty[], nullable — Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.

## Response `200`

Successful Response

- ListResourceCustomField
  - `items` CustomField[], required
    - union
      - CustomFieldText — Schema for a custom field of type text.
        - `created_at` string, date-time, required — Creation timestamp of the object.
        - `modified_at` string, date-time, nullable, required — Last modification timestamp of the object.
        - `id` string, uuid4, required — The ID of the object.
        - `metadata` MetadataOutputType, required
        - `type` 'text', required
        - `slug` string, required — Identifier of the custom field. It'll be used as key when storing the value.
        - `name` string, required — Name of the custom field.
        - `organization_id` string, uuid4, required — The ID of the organization owning the custom field.
        - `properties` CustomFieldTextProperties, required
          - `form_label` string
          - `form_help_text` string
          - `form_placeholder` string
          - `textarea` boolean
          - `min_length` integer
          - `max_length` integer
      - CustomFieldNumber — Schema for a custom field of type number.
        - `created_at` string, date-time, required — Creation timestamp of the object.
        - `modified_at` string, date-time, nullable, required — Last modification timestamp of the object.
        - `id` string, uuid4, required — The ID of the object.
        - `metadata` MetadataOutputType, required
        - `type` 'number', required
        - `slug` string, required — Identifier of the custom field. It'll be used as key when storing the value.
        - `name` string, required — Name of the custom field.
        - `organization_id` string, uuid4, required — The ID of the organization owning the custom field.
        - `properties` CustomFieldNumberProperties, required
          - `form_label` string
          - `form_help_text` string
          - `form_placeholder` string
          - `ge` integer
          - `le` integer
      - CustomFieldDate — Schema for a custom field of type date.
        - `created_at` string, date-time, required — Creation timestamp of the object.
        - `modified_at` string, date-time, nullable, required — Last modification timestamp of the object.
        - `id` string, uuid4, required — The ID of the object.
        - `metadata` MetadataOutputType, required
        - `type` 'date', required
        - `slug` string, required — Identifier of the custom field. It'll be used as key when storing the value.
        - `name` string, required — Name of the custom field.
        - `organization_id` string, uuid4, required — The ID of the organization owning the custom field.
        - `properties` CustomFieldDateProperties, required
          - `form_label` string
          - `form_help_text` string
          - `form_placeholder` string
          - `ge` integer
          - `le` integer
      - CustomFieldCheckbox — Schema for a custom field of type checkbox.
        - `created_at` string, date-time, required — Creation timestamp of the object.
        - `modified_at` string, date-time, nullable, required — Last modification timestamp of the object.
        - `id` string, uuid4, required — The ID of the object.
        - `metadata` MetadataOutputType, required
        - `type` 'checkbox', required
        - `slug` string, required — Identifier of the custom field. It'll be used as key when storing the value.
        - `name` string, required — Name of the custom field.
        - `organization_id` string, uuid4, required — The ID of the organization owning the custom field.
        - `properties` CustomFieldCheckboxProperties, required
          - `form_label` string
          - `form_help_text` string
          - `form_placeholder` string
      - CustomFieldSelect — Schema for a custom field of type select.
        - `created_at` string, date-time, required — Creation timestamp of the object.
        - `modified_at` string, date-time, nullable, required — Last modification timestamp of the object.
        - `id` string, uuid4, required — The ID of the object.
        - `metadata` MetadataOutputType, required
        - `type` 'select', required
        - `slug` string, required — Identifier of the custom field. It'll be used as key when storing the value.
        - `name` string, required — Name of the custom field.
        - `organization_id` string, uuid4, required — The ID of the organization owning the custom field.
        - `properties` CustomFieldSelectProperties, required
          - `form_label` string
          - `form_help_text` string
          - `form_placeholder` string
          - `options` CustomFieldSelectOption[], required
            - `value` string, required
            - `label` string, required
  - `pagination` Pagination, required
    - `total_count` integer, required
    - `max_page` integer, required

## Other responses

- `422` — Validation Error

---

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