Get availability templates

GET /employees/{employeeId}/availability-templates
O auth2

Get availability templates for an employee by its ID 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.

Path parameters

Query parameters

  • id array[string]

    ID(s) to be considered for filtering

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

  • is-default boolean

    Default flag to be considered for filtering

  • type array[string]

    Availability template type(s) to be considered for filtering

    At least 1 element. Values are DAY or WEEK.

Responses

  • 200 application/json

    Default Response

    Hide response attribute Show response attribute object
    • data array[object] Required
      Hide data attributes Show data attributes object
      • id string Required

        Minimum length is 1.

      • name string Required

        Minimum length is 1.

      • type string Required

        Values are DAY or WEEK.

      • timeZone string 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.

      • color string Required

        Minimum length is 1.

      • order integer Required

        Minimum value is 0.

      • isDefault boolean Required
      • createdAt string(date-time) Required

        Minimum length is 1.

      • updatedAt string(date-time) Required

        Minimum length is 1.
  • 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 
curl \
 --request GET 'https://api.pexipengage.com/enterprises/acme/employees/123/availability-templates' \
 --header "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 --header "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"
    }
  ]
}