v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB

Custom Fields

Get a list of 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.

get/v2/customers/custom-fields

Query parameters

customer_type'PERSON' | 'COMPANY'

page_numberinteger

One-based page index (1..N)

page_sizeinteger

The size of the page to be returned

Response

Successfully retrieved custom fields.

firststring required

The URL path to the first page.

nextstring nullable

The URL path to the next page.

prevstring nullable

The URL path to the previous page.

selfstring required

The URL path to the current page.

total_countinteger required

Total number of custom fields.

Example response

{
  "first": "/v2/customers/custom-fields?page_number=1",
  "next": "/v2/customers/custom-fields?page_number=2",
  "prev": "/v2/customers/custom-fields?page_number=1",
  "self": "/v2/customers/custom-fields?page_number=1",
  "total_count": 5
}