v1

latestOpenAPI 3.1.02026-07-24111290748.0 KB

Customers

List customer field values

List all custom fields for a customer.

get/api/customers/{customer_id}/custom-fields

Path parameters

customer_idinteger required

The ID of the customer.

Response

List of custom field values.

{"stackTrail":"components:schemas:CustomerCustomFieldWithValue:properties:value","oasType":"schema","type":"unknown","title":"value","description":"The value of the custom field for this particular customer."}

Example response

[
  {
    "field": {
      "id": 123,
      "external_id": "custom-field-84203241",
      "label": "Test field",
      "description": "An amazing field description.",
      "priority": 1,
      "required": true,
      "definition": {
        "input_settings": {
          "placeholder": "Enter this here..."
        }
      },
      "created_datetime": "2019-01-02T03:04:05.123456",
      "updated_datetime": "2020-01-02T03:04:05.123456",
      "deactivated_datetime": "2021-01-02T03:04:05.123456"
    }
  }
]