Get a context

GET /contexts/{id}
O auth2

Get a context 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 attribute Show response attribute object
    • data object Required

      Additional properties are NOT allowed.

      Hide data attributes Show data attributes object
      • externalId string | null

        Minimum length is 1, maximum length is 255.

      • appointmentExternalId string | null

        Minimum length is 1, maximum length is 255.

      • end string(date-time) | null

        Minimum length is 1.

      • metadata object | null

        Additional properties are allowed.

      • employeeIds array[string]

        ID(s) to be considered for filtering

        At least 1 element. Minimum length of each is 1.

      • secondaryEmployeeIds array[string]

        ID(s) to be considered for filtering

        At least 1 element. Minimum length of each is 1.

      • subjectIds array[string]

        ID(s) to be considered for filtering

        At least 1 element. Minimum length of each is 1.

      • subjectGroupIds array[string]

        ID(s) to be considered for filtering

        At least 1 element. Minimum length of each is 1.

      • listingIds array[string]

        ID(s) to be considered for filtering

        At least 1 element. Minimum length of each is 1.

      • leadSegmentIds array[string]

        ID(s) to be considered for filtering

        At least 1 element. Minimum length of each is 1.

      • meetingRoomIds array[string]

        ID(s) to be considered for filtering

        At least 1 element. Minimum length of each is 1.

      • meetingTypes array[string]

        Values are OFFICE, ON_LOCATION, PHONE, or VIDEO.

      • customerIds array[string]

        ID(s) to be considered for filtering

        At least 1 element. Minimum length of each is 1.

      • secondaryCustomerIds array[string]

        ID(s) to be considered for filtering

        At least 1 element. Minimum length of each is 1.

      • start string(date-time) | null

        Minimum length is 1.

      • id string Required

        Minimum length is 1.

      • expiresAt string(date-time) 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 /contexts/{id} 
curl \
 --request GET 'https://api.development.pexipengage.com/enterprises/acme/contexts/1234' \
 --header "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 --header "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
 --header "Accept-Language: en *"
Response examples (200) 
{
  "data": {
    "externalId": "ABCD1234",
    "appointmentExternalId": "ABCD1234",
    "end": "2025-05-04T09:42:00Z",
    "metadata": {},
    "employeeIds": [
      "123"
    ],
    "secondaryEmployeeIds": [
      "123"
    ],
    "subjectIds": [
      "123"
    ],
    "subjectGroupIds": [
      "123"
    ],
    "listingIds": [
      "123"
    ],
    "leadSegmentIds": [
      "123"
    ],
    "meetingRoomIds": [
      "123"
    ],
    "meetingTypes": [
      "OFFICE"
    ],
    "customerIds": [
      "123"
    ],
    "secondaryCustomerIds": [
      "123"
    ],
    "start": "2025-05-04T09:42:00Z",
    "id": "123",
    "expiresAt": "2025-05-04T09:42:00Z"
  }
}
Response examples (404) 
{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string"
    }
  ]
}