Holidays
Public API

List Company Holidays

Changed on

Returns a paginated list of active company holidays. Soft-deleted holidays are never returned. Supports OData filtering via filter, sorting via orderBy, field projection via select, and page-based pagination.

OAuth Scopes: holidays

get/api/v1/holidays

Request

Query parameters

filterstring

OData filter expression applied to company holidays. Supported operators: eq (equals, use eq null to match NULL), ne (not equals, use ne null to match NOT NULL), lt (less than), le (less than or equal), gt (greater than), ge (greater than or equal), in (value in list), and (combine clauses). Not supported: or, not, parenthesized grouping. Filterable fields: name, startDate, endDate, isPublic, globalHolidayUuid. Examples: startDate ge '2026-01-01', isPublic eq true and endDate ne null.

orderBystring

Comma-separated list of sort terms, each a field optionally followed by asc or desc. Allowed sort fields: name, startDate, endDate, createdAt, updatedAt.

selectstring

Comma-separated list of properties to include in each returned holiday. Reduces payload size. Example: id,name,startDate.

pageinteger

The page number to retrieve.

pageSizeinteger

The number of items to return per page.

Response

A paginated list of company holidays.

Example response

{
  "data": [
    {
      "id": 42,
      "name": "Independence Day",
      "startDate": "2026-07-04",
      "endDate": "2026-07-05",
      "countryCodes": [
        "US",
        "CA"
      ],
      "holidayPay": {
        "defaultHours": "8.00",
        "hoursByEmploymentStatus": [
          {
            "employmentStatusListValueId": 17946,
            "hours": "5.00"
          }
        ],
        "multiplier": "1.50"
      },
      "createdAt": "2026-04-30T18:00:00Z",
      "updatedAt": "2026-04-30T18:00:00Z"
    }
  ],
  "meta": {
    "page": 2,
    "pageSize": 20,
    "totalPages": 4,
    "totalItems": 68
  }
}

Changes