---
title: "Retrieve a paginated list of custom fields"
method: GET
path: "/v1/custom-fields"
tags: ["Custom Fields"]
---

# Retrieve a paginated list of custom fields

`GET /v1/custom-fields`

## Query parameters

- `created_at__gte` string, date-time
- `created_at__lte` string, date-time, nullable
- `order_by` 'created_at' | '-created_at'
- `page` integer
- `page_size` integer

## Response `200`

A paginated list of custom fields

- CountablePagedResponseUnionTypeMultiSelectSchemaStringSchema
  - `items` union[], required — The list of items on the current page.
    - union
      - MultiSelectSchema
        - `id` string, uuid, required
        - `name` string, required
        - `type` 'single-select' | 'multi-select' | 'string'
        - `external_id` string, nullable
        - `options` OptionSchema[], required
          - `id` string, uuid, required
          - `name` string, required
          - `external_id` string, nullable
          - `hidden` boolean, required
      - StringSchema
        - `id` string, uuid, required
        - `name` string, required
        - `type` 'single-select' | 'multi-select' | 'string'
        - `external_id` string, nullable
  - `page` integer, required — The current page number.
  - `page_size` integer, required — The number of items per page.
  - `created_at__lte` string, date-time, required — The most recent date for which results are included.
  - `created_at__gte` string, date-time, required — The least recent date for which results are included.
  - `ordered_by` 'created_at' | '-created_at', required
  - `pages` integer, required — The total number of pages available.
  - `count` integer, required — The total number of items available.

---

[API](https://skmtc.dev/floatfinancial/apis/float-public-api.md) · [All operations](https://skmtc.dev/floatfinancial/apis/float-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/floatfinancial/float-public-api/revisions/a3c42eb1b312/schema)