Headers
-
X-Correlation-Id
string Unique identifier to allow referencing a particular transaction or event chain
Minimum length is
1
. -
Accept-Language
string Returns the requested resources translated according to the passed languages (see translatable resources)
Minimum length is
1
.
Query parameters
-
id
array[string] ID(s) to be considered for filtering
At least
1
element. Minimum length of each is1
. -
external-id
array[string] External ID(s) to be considered for filtering
At least
1
element. Minimum length of each is1
, maximum length of each is255
. -
customer-number
array[string] Customer number(s) to be considered for filtering
At least
1
element. Minimum length of each is1
. -
search
string Filters the results to only include customers whose first name, last name or email address contains the given search string
Minimum length is
1
. -
offset
string(positive-integer) Offset for the results to be returned
Default value is
0
. -
limit
string(positive-integer) Limitation for the number of results to be returned
Default value is
25
. -
with-deleted
boolean Includes deleted resources in the results
curl \
--request GET 'https://api.pexipengage.com/enterprises/acme/customers' \
--header "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
--header "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
--header "Accept-Language: en *"
{
"data": [
{
"id": "123",
"externalId": "ABCD1234",
"customerNumber": "123456",
"email": "john.doe@pexip.com",
"firstName": "John",
"lastName": "Doe",
"company": "Acme Corp",
"language": "da",
"notes": "Lorem ipsum",
"phoneNumber": "+32412345678",
"existing": true,
"timeZone": "Europe/Brussels",
"createdAt": "2022-08-17T19:05:21.362Z",
"updatedAt": "2022-08-17T19:05:21.362Z",
"deletedAt": "2022-08-17T19:05:21.362Z",
"location": {
"city": {
"language": "en",
"value": "Lorem ipsum"
},
"state": {
"language": "en",
"value": "Lorem ipsum"
},
"street1": {
"language": "en",
"value": "Lorem ipsum"
},
"street2": {
"language": "en",
"value": "Lorem ipsum"
},
"postalCode": "9000",
"countryCode": "BE",
"formattedAddress": "string",
"geolocation": {
"latitude": 51.0479466,
"longitude": 3.6912248
}
}
}
],
"meta": {
"offset": 0,
"limit": 25,
"totalCount": 42
}
}