Pexip Engage API documentation

Get subjects

GET /subjects

OAuth2

Get 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

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.
enabled-for-internal-use boolean

Status to be considered for filtering
enabled-for-customer-use boolean

Status to be considered for filtering
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.
  
  enabledForInternalUse boolean Required
  
  enabledForCustomerUse boolean Required
  
  order integer Required
  
  Minimum value is 0.
  
  externalId string | null
  
  Minimum length is 1, maximum length is 255.
  
  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
  
  subjectGroup object Required
  
  Hide subjectGroup attributes Show subjectGroup attributes
  
  id string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  cancellationByAgentForm object | null
  
  Hide cancellationByAgentForm attributes Show cancellationByAgentForm attributes
  
  id string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  cancellationByCustomerForm object | null
  
  Hide cancellationByCustomerForm attributes Show cancellationByCustomerForm attributes
  
  id string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  completionByAgentForm object | null
  
  Hide completionByAgentForm attributes Show completionByAgentForm attributes
  
  id string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  questionnaireForm object | null
  
  Hide questionnaireForm attributes Show questionnaireForm attributes
  
  id string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  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.
  
  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 /subjects

curl \
 -X GET https://api.pexipengage.com/enterprises/acme/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",
      "enabledForInternalUse": true,
      "enabledForCustomerUse": true,
      "order": 5,
      "externalId": "ABCD1234",
      "name": {
        "language": "en",
        "value": "Lorem ipsum"
      },
      "description": {
        "language": "en",
        "value": "Lorem ipsum"
      },
      "instructions": {
        "language": "en",
        "value": "Lorem ipsum"
      },
      "subjectGroup": {
        "id": "123"
      },
      "cancellationByAgentForm": {
        "id": "123"
      },
      "cancellationByCustomerForm": {
        "id": "123"
      },
      "completionByAgentForm": {
        "id": "123"
      },
      "questionnaireForm": {
        "id": "123"
      },
      "createdAt": "2022-08-17T19:05:21.362Z",
      "updatedAt": "2022-08-17T19:05:21.362Z",
      "deletedAt": "2022-08-17T19:05:21.362Z"
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 25,
    "totalCount": 42
  }
}