Skip to content

Holiday Calendars

Holiday Calendars define the days in which account members are unavailable to work due to company-wide days off.

Operations

Fetching a list of Holiday Calendars

Request

This endpoint returns structured Holiday Calendar objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the holiday_calendars top-level JSON key. Please see our Response Format section for more information.

Query
matchingstring

Limits holiday calendars to names matching the specified query.

onlystring

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

orderstring

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: default, name:asc, and name:desc.

Default:"default"
pageinteger, (int32)
Default:1
per_pageinteger, (int32), <= 200
Default:20
GET
/holiday_calendars
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/holiday_calendars?matching=string&only=string&order=default&page=1&per_page=20'

Responses

A list of Holiday Calendars have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
holiday_calendarsobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "holiday_calendars": {
    "property1": {
      "default": true,
      "name": "string"
    },
    "property2": {
      "default": true,
      "name": "string"
    }
  }
}