GET
/api/public/v1/customers/{accountId}/custom-fields

Get customer custom field values

Read all custom field values stored on a single customer.

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

Path Parameters

NameTypeRequiredDescription
accountIdstringRequiredCustomer (account) ID.
GETExample request
curl
curl -X GET "https://www.pxb.app/api/public/v1/customers/{accountId}/custom-fields" \
  -H "Authorization: Bearer your_access_token"
200Example response
json
{
  "message": "Customer custom field values retrieved successfully!",
  "content": {
    "values": [
      {
        "id": "cfv_1",
        "customFieldId": "cf_1",
        "textValue": "email"
      }
    ]
  }
}

In the console

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

xRM → Accounts
/xrm
  1. Open a customer to see their custom field values.