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

# List custom fields

`GET /v1/custom-fields/`

Retrieve all custom field definitions for the authenticated user. Custom fields allow you to add structured data to contacts beyond the built-in fields.

## Query parameters

- `select` object

## Response `200`

Successful response

- object
  - `error` boolean, required
  - `data` object, required
    - `custom_fields` object[], required
      - `id` string, uuid, required
      - `user_id` string
      - `name` string
      - `field_type` string
      - `categories` string[]
      - `ranking` integer, nullable

## Other responses

- `400` — Request body failed validation.
- `401` — Missing or invalid API key.
- `403` — Valid key, insufficient permission.
- `404` — Resource does not exist.
- `429` — Rate limit exceeded.
- `500` — Unexpected server error.

---

[API](https://skmtc.net/getdex/apis/dex-public-api.md) · [All operations](https://skmtc.net/getdex/apis/dex-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getdex/dex-public-api/versions/6f01cd52ac12/schema)