Get an availability template

GET /employees/{employeeId}/availability-templates/{id}
OAuth2

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

  • id string Required

    Minimum length is 1.

Responses

GET /employees/{employeeId}/availability-templates/{id} 
curl \
 -X GET https://api.pexipengage.com/enterprises/acme/employees/123/availability-templates/123 \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002"
Response examples (200) 
{
  "data": {
    "id": "123",
    "name": "string",
    "type": "WEEK",
    "timeZone": "Europe/Brussels",
    "employee": {
      "id": "123"
    },
    "color": "#89d0c1",
    "order": 5,
    "isDefault": true,
    "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"
    }
  ]
}