v1

latestOpenAPI 3.0.22026-07-223907721.1 MB
customer

Query Customer Custom Field Values

Query all custom fields and corresponding values for a specific customer

get/v2/customers/{customerId}/customfields

Path parameters

customerIdstring uuid required

Represents a unique key for identifying a customer in the JTL system.

Example:b45f6432-2462-4c6f-b00f-1d9d01000000

The id of the customer that the custom field belongs to.

Headers

x-tenant-idstring uuid required

The tenant ID for the target ERP instance.

x-runasstring

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

x-companyidstring

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Response

The requested custom fields values for a customer .

customFieldIdstring uuid
valueobject

The custom field value. The object should match the custom field type.

Example response

[
  {
    "customFieldId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
  }
]