Skip to content

Holidays

Holidays are the company-wide days off that have been added to a user's Kantata OX account.

Operations

Fetching a list of Holidays

Request

This endpoint returns structured Holiday 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 holidays top-level JSON key. Please see our Response Format section for more information.

Query
includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • holiday_calendar_associations (HolidayCalendarAssociation) - The Holiday Calendar Associations for this Holiday.
matchingstring

Includes holidays matching the specified name.

not_on_calendarsstring

Includes holidays not specified in the comma separated list of calendar IDs.

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.

optional_fieldsArray of strings

Allows you to request one or more optional fields as an array.

Items Value:"calendar_names_list"
orderstring

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

Valid values: start_date:asc and start_date:desc.

Default:"start_date:asc"
pageinteger, (int32)
Default:1
per_pageinteger, (int32), <= 200
Default:20
GET
/holidays
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/holidays?include=string&matching=string&not_on_calendars=string&only=string&optional_fields=calendar_names_list&order=start_date%3Aasc&page=1&per_page=20'

Responses

A list of Holidays have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
holidaysobject
holiday_calendar_associationsobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "holidays": {
    "property1": {
      "calendar_names_list": "string",
      "end_date": "2019-08-24",
      "holiday_calendar_association_ids": [
        "string"
      ],
      "name": "string",
      "paid": true,
      "start_date": "2019-08-24",
      "total_hours": 0
    },
    "property2": {
      "calendar_names_list": "string",
      "end_date": "2019-08-24",
      "holiday_calendar_association_ids": [
        "string"
      ],
      "name": "string",
      "paid": true,
      "start_date": "2019-08-24",
      "total_hours": 0
    }
  },
  "holiday_calendar_associations": {
    "property1": {
      "holiday_calendar_id": "string",
      "holiday_calendar_name": "string",
      "holiday_id": "string",
      "holiday_name": "string"
    },
    "property2": {
      "holiday_calendar_id": "string",
      "holiday_calendar_name": "string",
      "holiday_id": "string",
      "holiday_name": "string"
    }
  }
}