GOgorgias
Customers

List customer field values

Changed on

List all custom fields for a customer.

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

Request

Path parameters

customer_idinteger required

The ID of the customer.

Response

List of custom field values.

valueunknown required

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"
    }
  }
]

Changes

  • 3fdfcb5b6678Revision changes
    • breaking

      the // response property's maxLength was increased from 255 to 1024 for the response status