Pexip Engage API documentation

Get customers

GET /customers

OAuth2

Get customers with filtering

Headers

Authorization string

Bearer token used for authorization

Minimum length is 1.
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 is 1.
external-id array[string]

External ID(s) to be considered for filtering

At least 1 element. Minimum length of each is 1, maximum length of each is 255.
customer-number array[string]

Customer number(s) to be considered for filtering

At least 1 element. Minimum length of each is 1.
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

Responses

• 200 application/json

Successful operation
Hide response attributes Show response attributes object
- data array[object] Required
  
  Hide data attributes Show data attributes object
  
  id string Required
  
  Minimum length is 1.
  
  externalId string | null
  
  Minimum length is 1, maximum length is 255.
  
  customerNumber string | null
  
  Minimum length is 1.
  
  email string | null
  
  Minimum length is 1.
  
  firstName string | null
  
  Minimum length is 1.
  
  lastName string | null
  
  Minimum length is 1.
  
  company string | null
  
  Minimum length is 1.
  
  language string | null
  
  Values are da, de, el, en, es, fr, ja, nl, no, or pl.
  
  notes string | null
  
  Minimum length is 1.
  
  phoneNumber string | null
  
  Minimum length is 1.
  
  existing boolean Required
  
  timeZone string Required
  
  Minimum length is 1.
  
  createdAt string(date-time) Required
  
  Minimum length is 1.
  
  updatedAt string(date-time) Required
  
  Minimum length is 1.
  
  deletedAt string(date-time) | null Required
  
  Minimum length is 1.
  
  location object | null
  
  Hide location attributes Show location attributes
  
  city object | null Required
  
  Hide city attributes Show city attributes
  
  language string Required
  
  Values are da, de, el, en, es, fr, ja, nl, no, or pl.
  
  value string Required
  
  Additional properties are NOT allowed
  
  state object | null Required
  
  Hide state attributes Show state attributes
  
  language string Required
  
  Values are da, de, el, en, es, fr, ja, nl, no, or pl.
  
  value string Required
  
  Additional properties are NOT allowed
  
  street1 object | null Required
  
  Hide street1 attributes Show street1 attributes
  
  language string Required
  
  Values are da, de, el, en, es, fr, ja, nl, no, or pl.
  
  value string Required
  
  Additional properties are NOT allowed
  
  street2 object | null Required
  
  Hide street2 attributes Show street2 attributes
  
  language string Required
  
  Values are da, de, el, en, es, fr, ja, nl, no, or pl.
  
  value string Required
  
  Additional properties are NOT allowed
  
  postalCode string | null
  
  Minimum length is 1.
  
  countryCode string Required
  
  Minimum length is 2, maximum length is 2.
  
  formattedAddress string Required
  
  Minimum length is 1.
  
  geolocation object Required
  
  Hide geolocation attributes Show geolocation attributes
  
  latitude number Required
  
  Minimum value is -90, maximum value is 90.
  
  longitude number Required
  
  Minimum value is -180, maximum value is 180.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- meta object Required
  
  Hide meta attributes Show meta attributes
  
  offset integer Required
  
  Minimum value is 0. Default value is 0.
  
  limit integer Required
  
  Minimum value is 0. Default value is 25.
  
  totalCount integer Required
  
  Minimum value is 0.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed

GET /customers

curl \
 -X GET https://api.pexipengage.com/enterprises/acme/customers \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
 -H "Accept-Language: en *"

Response examples (200)

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