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.
Path parameters
-
id string Required
Primary identifier of the requested resource
Minimum length is
1.
GET /subjects/{id}
curl \
-X GET https://api.pexipengage.com/enterprises/acme/subjects/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",
"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",
"translations": {
"name": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"description": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"instructions": [
{
"language": "en",
"value": "Lorem ipsum"
}
]
}
}
}
Response examples (404)
{
"errors": [
{
"message": "string",
"code": "string",
"type": "string",
"statusCode": "string"
}
]
}