Get defined availability

GET /defined-availability

O auth2

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

200 application/json

Successful operation
Hide response attribute Show response attribute object
- data array[object] Required
  
  Hide data attributes Show data attributes object
  
  start string(date-time) Required
  
  Minimum length is 1.
  
  end string(date-time) Required
  
  Minimum length is 1.
  
  employee object Required
  
  Additional properties are NOT allowed.
  
  Hide employee attribute Show employee attribute object
  
  id string Required
  
  Minimum length is 1.
  
  office object Required
  
  Additional properties are NOT allowed.
  
  Hide office attribute Show office attribute object
  
  id string Required
  
  Minimum length is 1.
  
  subject object Required
  
  Additional properties are NOT allowed.
  
  Hide subject attribute Show subject attribute object
  
  id string Required
  
  Minimum length is 1.
  
  meetingType string Required
  
  Values are OFFICE, ON_LOCATION, PHONE, or VIDEO.
  
  forceManualAccept boolean Required
  
  maxConcurrentAppointments integer Required
  
  Minimum value is 0.

GET /defined-availability

curl \
 --request GET 'https://api.pexipengage.com/enterprises/acme/defined-availability?from=2025-05-04T09%3A42%3A00Z&to=2025-05-04T09%3A42%3A00Z&office-id=123' \
 --header "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 --header "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
    }
  ]
}