Skip to main content
GET
/
v1
/
customers
/
{customerId}
/
customfields
Query Customer Custom Field Values
curl --request GET \
  --url https://api.jtl-cloud.com/erp/v1/customers/{customerId}/customfields \
  --header 'Authorization: Bearer <token>' \
  --header 'x-tenant-id: <x-tenant-id>'
[
  {
    "CustomFieldId": 123,
    "Value": {}
  }
]

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

​
x-runas
string

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

​
x-companyid
string

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

Path Parameters

​
customerId
integer<int32>
required

The id of the customer that the custom field belongs to. Represents a unique key for identifying a customer in the JTL system.

Response

The requested custom fields values for a customer .

​
CustomFieldId
integer<int32>
required

Unique ID to identifify a custom field.

​
Value
object
required

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