Get unavailability

GET /unavailability

OAuth2

Get unavailability 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

employee-id array[string]

ID(s) to be considered for filtering

At least 1 element. Minimum length of each is 1.
start string(date-time)

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

Minimum length is 1.
end string(date-time)

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

Minimum length is 1.
type array[string]

Unavailability type(s) to be considered for filtering

At least 1 element. Values are APPOINTMENT, EXTERNAL_CALENDAR, LISTING_EXCLUSIVITY, or USER_DEFINED.
offset string(positive-integer)

Offset for the results to be returned

Default value is 0.
limit string(positive-integer)

Limitation for the number of results to be returned

Default value is 25.

Responses

200 application/json

Successful operation
Hide response attributes Show response attributes object
- data array[object] Required
  
  Hide data attributes Show data attributes object
  
  employee object Required
  
  Hide employee attributes Show employee attributes object
  
  id string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  start string(date-time) | null
  
  Minimum length is 1.
  
  startDate string | null
  
  Minimum length is 1.
  
  end string(date-time) | null
  
  Minimum length is 1.
  
  endDate string | null
  
  Minimum length is 1.
  
  type string Required
  
  Values are APPOINTMENT, EXTERNAL_CALENDAR, LISTING_EXCLUSIVITY, or USER_DEFINED.
  
  externalId string | null
  
  Minimum length is 1, maximum length is 255.
  
  createdAt string(date-time) Required
  
  Minimum length is 1.
  
  updatedAt string(date-time) Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
- meta object Required
  
  Hide meta attributes Show meta attributes object
  
  offset integer Required
  
  Minimum value is 0. Default value is 0.
  
  limit integer Required
  
  Minimum value is 0. Default value is 25.
  
  totalCount integer Required
  
  Minimum value is 0.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed

GET /unavailability

curl \
 -X GET https://api.development.pexipengage.com/enterprises/acme/unavailability \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002"

Response examples (200)

{
  "data": [
    {
      "employee": {
        "id": "123"
      },
      "start": "2022-08-01T00:00:00.000Z",
      "startDate": "2022-08-01",
      "end": "2022-08-17T00:00:00.000Z",
      "endDate": "2022-08-17",
      "type": "USER_DEFINED",
      "externalId": "ABCD1234",
      "createdAt": "2022-08-17T19:05:21.362Z",
      "updatedAt": "2022-08-17T19:05:21.362Z"
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 25,
    "totalCount": 42
  }
}