Get availability time ranges

GET /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges

OAuth2

Get availability time ranges for an availability template 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.

Path parameters

employeeId string Required

Minimum length is 1.
availabilityTemplateId string Required

Minimum length is 1.

Responses

200 application/json

Default Response
Hide response attributes Show response attributes object
- data array[object] Required
  
  Hide data attributes Show data attributes object
  
  id string Required
  
  Minimum length is 1.
  
  dayOfWeek string | null
  
  Values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, or WEDNESDAY.
  
  startTime string Required
  
  Minimum length is 1.
  
  endTime string Required
  
  Minimum length is 1.
  
  availabilityTemplate object Required
  
  Hide availabilityTemplate attributes Show availabilityTemplate attributes object
  
  id string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  createdAt string(date-time) Required
  
  Minimum length is 1.
  
  updatedAt string(date-time) Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
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 /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges

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

Response examples (200)

{
  "data": [
    {
      "id": "123",
      "dayOfWeek": "MONDAY",
      "startTime": "09:00",
      "endTime": "17:00",
      "availabilityTemplate": {
        "id": "123"
      },
      "createdAt": "2022-08-17T19:05:21.362Z",
      "updatedAt": "2022-08-17T19:05:21.362Z"
    }
  ]
}

Response examples (404)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string"
    }
  ]
}