---
title: "Get a list of custom fields"
method: GET
path: "/v2/customers/custom-fields"
tags: ["Custom Fields"]
---

# Get a list of custom fields

`GET /v2/customers/custom-fields`

This endpoint returns a paginated list of custom fields which can be optionally filtered by customer type.


You need the "View customers" permission to use this endpoint.

## Query parameters

- `customer_type` 'PERSON' | 'COMPANY'
- `page_number` integer
- `page_size` integer

## Response `200`

Successfully retrieved custom fields.

- CustomerManagerPaginatedCustomFieldsResponse
  - `custom_fields` CustomerManagerCustomField[], required — List of custom fields.
    - `customer_type` 'PERSON' | 'COMPANY', required
    - `data_type` 'TEXT' | 'INTEGER' | 'DECIMAL' | 'DATE' | 'DATETIME', required — The type of data stored in a custom field.
    - `display_name` string, required
    - `identifier` string, uuid, required
    - `key` string, required
  - `first` string, required — The URL path to the first page.
  - `next` string, nullable — The URL path to the next page.
  - `prev` string, nullable — The URL path to the previous page.
  - `self` string, required — The URL path to the current page.
  - `total_count` integer, required — Total number of custom fields.

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found

---

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