Pexip Engage API documentation

Get schedulable subjects

GET /schedulable/subjects

Get schedulable subjects 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

employee-id array[string]

Employee ID(s) to be considered for filtering

At least 1 element. Minimum length of each is 1.
employee-external-id array[string]

Employee external ID(s) to be considered for filtering

At least 1 element. Minimum length of each is 1, maximum length of each is 255.
lead-segment-id string

Lead segment ID to be considered for filtering

Minimum length is 1.
lead-segment-code string

Lead segment code to be considered for filtering

Minimum length is 1, maximum length is 255.
listing-id string

Listing ID to be considered for filtering

Minimum length is 1.
listing-external-id string

Listing external ID to be considered for filtering

Minimum length is 1, maximum length is 255.
location object
Hide location attributes Show location attributes
- latitude number
  
  Minimum value is -90, maximum value is 90.
- longitude number
  
  Minimum value is -180, maximum value is 180.
- Additional properties are NOT allowed
meeting-type array[string]

Meeting type(s) to be considered for filtering

Values are OFFICE, ON_LOCATION, PHONE, or VIDEO.
office-id array[string]

Office ID(s) to be considered for filtering

At least 1 element. Minimum length of each is 1.
office-external-id array[string]

Office external ID(s) to be considered for filtering

At least 1 element. Minimum length of each is 1, maximum length of each is 255.
order-by-distance-to object
Hide order-by-distance-to attributes Show order-by-distance-to attributes
- latitude number
  
  Minimum value is -90, maximum value is 90.
- longitude number
  
  Minimum value is -180, maximum value is 180.
- Additional properties are NOT allowed
subject-id array[string]

Subject ID(s) to be considered for filtering

At least 1 element. Minimum length of each is 1.
subject-external-id array[string]

Subject external ID(s) to be considered for filtering

At least 1 element. Minimum length of each is 1, maximum length of each is 255.
subject-group-id array[string]

Subject group ID(s) to be considered for filtering

At least 1 element. Minimum length of each is 1.
subject-group-external-id array[string]

Subject group external ID(s) to be considered for filtering

At least 1 element. Minimum length of each is 1, maximum length of each is 255.

Responses

• 200 application/json

Default Response
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.
  
  name object | null Required
  
  Hide name attributes Show name 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
  
  description object | null Required
  
  Hide description attributes Show description 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
  
  instructions object | null Required
  
  Hide instructions attributes Show instructions 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
  
  externalId string | null
  
  Minimum length is 1, maximum length is 255.
  
  order integer Required
  
  Minimum value is 0.
  
  subjectGroup object Required
  
  Hide subjectGroup attributes Show subjectGroup attributes
  
  id string Required
  
  Minimum length is 1.
  
  color string Required
  
  Minimum length is 7, maximum length is 7.
  
  order integer Required
  
  Minimum value is 0.
  
  externalId string | null
  
  Minimum length is 1, maximum length is 255.
  
  image string(uri) | null
  
  Minimum length is 1.
  
  name object | null Required
  
  Hide name attributes Show name 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
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed

GET /schedulable/subjects

curl \
 -X GET https://api.pexipengage.com/enterprises/acme/schedulable/subjects \
 -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",
      "name": {
        "language": "en",
        "value": "Lorem ipsum"
      },
      "description": {
        "language": "en",
        "value": "Lorem ipsum"
      },
      "instructions": {
        "language": "en",
        "value": "Lorem ipsum"
      },
      "externalId": "ABCD1234",
      "order": 5,
      "subjectGroup": {
        "id": "123",
        "color": "#89d0c1",
        "order": 5,
        "externalId": "ABCD1234",
        "image": "https://wwww.example.net/abc123",
        "name": {
          "language": "en",
          "value": "Lorem ipsum"
        }
      }
    }
  ]
}