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

# List Custom Fields

`GET /api/v1/custom-fields`

List custom fields for the caller's organization.

## Query parameters

- `category` 'HRIS' | 'ATS' | 'LMS'
- `model` string, nullable — Filter by model slug, e.g. employee.
- `source` 'DASHBOARD' | 'API'
- `page_size` integer — Number of results to return per page. Maximum size is 200.
- `cursor` string — The pagination cursor value.

## Response `200`

Successful Response

- PaginatedResponseCustomFieldExternal
  - `cursor` string, nullable, required — Cursor value to fetch next set of items
  - `page_size` integer, required — Indicates the count of items in the response
  - `items` CustomFieldExternal[], required — List of items in the current response
    - `id` string, uuid, required — Unique identifier of the custom field.
    - `name` string, required — Name of the custom field (snake_case).
    - `description` string, nullable — Description of the custom field.
    - `category` 'HRIS' | 'ATS' | 'LMS', required
    - `model` string, required — Model on which the custom field is applied.
    - `source` 'DASHBOARD' | 'API', required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, nullable

## Other responses

- `401` — Missing or invalid bearer authentication credentials.
- `403` — The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.
- `422` — Validation Error
- `429` — Rate limit exceeded.

---

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