REST DocumentationHoliday CalendarsGET List holiday calendars

List holiday calendars

Returns a paginated list of the holiday calendars, sorted by id. The id is the value a regular working time carries as holiday_calendar_id.

Availability: Full version and ZEP Clock

Request

GET /api/v1/holiday-calendars
curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/holiday-calendars' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}'

Query parameters

  • Name
    limit
    Type
    integer, nullable
    Description

    The number of records per page, 1 to 200. Defaults to 15.

  • Name
    page
    Type
    integer, nullable
    Description

    The page of results to return, counting from 1.

Response

{
  "data": [
    {
      "id": 1,
      "name": "EU",
      "note": "Familienurlaub",
      "country": "Deutschland",
      "region": "East Tabitha",
      "created": "2024-07-20T11:30:00.000000Z",
      "modified": "2024-07-20T12:30:00.000000Z"
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "string",
        "label": "string",
        "active": true
      }
    ],
    "path": "string",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Response fields

  • Name
    id
    Type
    integer
    Description

    Unique identifier of the holiday calendar.

  • Name
    name
    Type
    string
    Description

    Short designation of the holiday calendar.

  • Name
    note
    Type
    string, nullable
    Description

    Free-text note attached to the holiday calendar.

  • Name
    country
    Type
    string, nullable
    Description

    Country whose public holidays this calendar covers.

  • Name
    region
    Type
    string, nullable
    Description

    Region or state within the country this calendar covers, if narrowed down.

  • Name
    created
    Type
    string (date-time), nullable
    Description

    Timestamp the holiday calendar was created.

  • Name
    modified
    Type
    string (date-time), nullable
    Description

    Timestamp the holiday calendar was last modified.

Generated from the OpenAPI specification — edit the source code, not this page.