Get a subject

GET /subjects/{id}

Get a subject by its ID

Headers

Path parameters

  • id string Required

    Primary identifier of the requested resource

    Minimum length is 1.

Responses

  • 200 application/json

    Successful operation

    Hide response attribute Show response attribute object
    • data object Required

      Additional properties are NOT allowed.

      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

        Additional properties are NOT allowed.

        Hide name attributes Show name attributes object | null
        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required
      • description object | null Required

        Additional properties are NOT allowed.

        Hide description attributes Show description attributes object | null
        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required
      • instructions object | null Required

        Additional properties are NOT allowed.

        Hide instructions attributes Show instructions attributes object | null
        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required
      • subjectGroup object Required

        Additional properties are NOT allowed.

        Hide subjectGroup attribute Show subjectGroup attribute object
        • id string Required

          Minimum length is 1.

      • Additional properties are NOT allowed.

        Hide cancellationByAgentForm attribute Show cancellationByAgentForm attribute object | null
        • id string Required

          Minimum length is 1.

      • Additional properties are NOT allowed.

        Hide cancellationByCustomerForm attribute Show cancellationByCustomerForm attribute object | null
        • id string Required

          Minimum length is 1.

      • Additional properties are NOT allowed.

        Hide completionByAgentForm attribute Show completionByAgentForm attribute object | null
        • id string Required

          Minimum length is 1.

      • questionnaireForm object | null

        Additional properties are NOT allowed.

        Hide questionnaireForm attribute Show questionnaireForm attribute object | null
        • id 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.

      • translations object Required

        Additional properties are NOT allowed.

        Hide translations attributes Show translations attributes object
        • name array[object] Required

          At least 1 element.

          Hide name attributes Show name 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.

        • description array[object]

          At least 0 elements.

          Hide description attributes Show description 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.

        • instructions array[object]

          At least 0 elements.

          Hide instructions attributes Show instructions 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.

  • 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 /subjects/{id}
curl \
 -X GET https://api.development.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"
    }
  ]
}