v4

latestSwagger 2.02026-08-0343714211.7 MB

holiday_calendars

Holiday Calendars

List Holiday Calendars

get/holiday_calendars

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are .

Response

A list of HolidayCalendars objects.

idinteger

Holiday Calendar ID. Use custom_<id> as a scheduled resource's holiday_region.

namestring

Holiday Calendar name.

definitionobject

Holiday rules for the calendar. For more information, refer to the Holiday Calendars section of the Files.com documentation.

created_atstring date-time

Creation time.

updated_atstring date-time

Last update time.

Example response

[
  {
    "id": 1,
    "name": "Company Holidays",
    "created_at": "2000-01-01T01:00:00Z",
    "updated_at": "2000-01-01T01:00:00Z"
  }
]