Pexip Engage API documentation

Get a customer

GET /customers/{id}

OAuth2

Get a customer by its ID

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.

Path parameters

id string Required

Primary identifier of the requested resource

Minimum length is 1.

Responses

• 200 application/json

Successful operation
Hide response attributes Show response attributes object
- data object Required
  
  Hide data attributes Show data attributes
  
  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
  
  translations object Required
  
  Hide translations attributes Show translations attributes
  
  city array[object] Required
  
  At least 1 element.
  
  Hide city attributes Show city attributes object
  
  language string Required
  
  Values are da, de, el, en, es, fr, ja, nl, no, or pl.
  
  value string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  state array[object]
  
  At least 0 elements.
  
  Hide state attributes Show state attributes object
  
  language string Required
  
  Values are da, de, el, en, es, fr, ja, nl, no, or pl.
  
  value string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  street1 array[object] Required
  
  At least 1 element.
  
  Hide street1 attributes Show street1 attributes object
  
  language string Required
  
  Values are da, de, el, en, es, fr, ja, nl, no, or pl.
  
  value string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  street2 array[object]
  
  At least 0 elements.
  
  Hide street2 attributes Show street2 attributes object
  
  language string Required
  
  Values are da, de, el, en, es, fr, ja, nl, no, or pl.
  
  value string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
• 404 application/json

Resource not found
Hide response attribute Show response attribute object
- errors array[object] Required
  
  At least 1 element.
  
  Hide errors attributes Show errors attributes object
  
  message string Required
  
  Minimum length is 1.
  
  code string Required
  
  Minimum length is 1.
  
  type string Required
  
  Minimum length is 1.
  
  statusCode string Required
  
  Minimum length is 1.

GET /customers/{id}

curl \
 -X GET https://api.pexipengage.com/enterprises/acme/customers/1234 \
 -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
      },
      "translations": {
        "city": [
          {
            "language": "en",
            "value": "Lorem ipsum"
          }
        ],
        "state": [
          {
            "language": "en",
            "value": "Lorem ipsum"
          }
        ],
        "street1": [
          {
            "language": "en",
            "value": "Lorem ipsum"
          }
        ],
        "street2": [
          {
            "language": "en",
            "value": "Lorem ipsum"
          }
        ]
      }
    }
  }
}

Response examples (404)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string"
    }
  ]
}