Get defined availability

GET /defined-availability
OAuth2

Get defined availability 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 array[string]

    Subject ID(s) to be considered for filtering

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

  • meeting-type array[string]

    Meeting type(s) to be considered for filtering

    At least 1 element. Values are OFFICE, ON_LOCATION, PHONE, or VIDEO.

Responses

GET /defined-availability 
curl \
 -X GET https://api.pexipengage.com/enterprises/acme/defined-availability?from=2024-05-04T09%3A42%3A00%2B00%3A00&to=2024-05-04T09%3A42%3A00%2B00%3A00&office-id=123 \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002"
Response examples (200) 
{
  "data": [
    {
      "start": "2022-08-17T09:00:00.000Z",
      "end": "2022-08-17T17:00:00.000Z",
      "employee": {
        "id": "123"
      },
      "office": {
        "id": "123"
      },
      "subject": {
        "id": "123"
      },
      "meetingType": "OFFICE",
      "forceManualAccept": true,
      "maxConcurrentAppointments": 5
    }
  ]
}