GET
/api/public/v1/customer-custom-fields

List customer custom fields

List all custom field definitions for a location.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Dev Tools → API, to an assistant or CLI sign-in when you approve or edit it under Dev Tools, and to a teammate under Employee → Permissions.

customer:custom-fields:read

Query Parameters

NameTypeRequiredDescription
locationIdstringRequiredLocation to query.
GETExample request
curl
curl -X GET "https://www.pxb.app/api/public/v1/customer-custom-fields" \
  -H "Authorization: Bearer your_access_token"
200Example response
json
{
  "message": "Customer custom fields retrieved successfully!",
  "content": {
    "customFields": [
      {
        "id": "cf_1",
        "name": "preferred_contact",
        "type": "SELECT",
        "label": "Preferred contact method"
      }
    ]
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

xRM → Accounts → Custom fields
/xrm
  1. Open the Custom fields dialog from the accounts table header.