Get timetable

GET /timetable
OAuth2

Get timetable 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.

Query parameters

  • from string(date-time) Required

    Start date and time to be considered for filtering (ISO 8601)

    Minimum length is 1.

  • to string(date-time) Required

    End date and time to be considered for filtering (ISO 8601)

    Minimum length is 1.

  • employee-id array[string]

    Employee ID(s) to be considered for filtering

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

  • office-id string Required

    Office ID to be considered for filtering

    Minimum length is 1.

  • subject-id string Required

    Subject ID to be considered for filtering

    Minimum length is 1.

  • meeting-type string Required

    Meeting type to be considered for filtering

    Values are OFFICE, ON_LOCATION, PHONE, or VIDEO.

  • lead-segment-id string

    Lead segment ID to be considered for filtering

    Minimum length is 1.

  • listing-id string

    Listing ID to be considered for filtering

    Minimum length is 1.

  • location object

    Location to be considered for filtering

    Hide location attributes Show location attributes

Responses

GET /timetable 
curl \
 -X GET https://api.pexipengage.com/enterprises/acme/timetable?from=2024-05-04T09%3A42%3A00%2B00%3A00&to=2024-05-04T09%3A42%3A00%2B00%3A00&office-id=123&subject-id=123&meeting-type=OFFICE \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002"
Response examples (200) 
{
  "data": {
    "duration": 5,
    "earliestPossible": "2022-08-01T09:00:00.000Z",
    "latestPossible": "2022-09-01T17:00:00.000Z",
    "listing": {
      "id": "123"
    },
    "meetingType": "OFFICE",
    "office": {
      "id": "123"
    },
    "slots": [
      {
        "availableEmployees": [
          {
            "autoAccept": true,
            "employee": {
              "id": "123"
            }
          }
        ],
        "start": "2022-08-01T09:00:00.000Z",
        "end": "2022-08-01T10:00:00.000Z"
      }
    ],
    "subject": {
      "id": "123"
    },
    "trailingBufferTime": 5
  }
}
Response examples (422) 
{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string",
      "arguments": {}
    }
  ]
}