Mavenlink Holidays API

openapi: 3.2.0
info:
  version: 1.0.0
  title: Kantata OX API Documentation Holidays API
  description: Kantata OX's API provides access to the majority of Kantata OX's data model.
  termsOfService: https://www.kantata.com/terms-of-use
  contact:
    name: Kantata OX Support
    url: https://knowledge.kantata.com/hc/en-us
  license:
    name: COPYRIGHT © 2026 Kantata, Inc.
    url: https://www.kantata.com/terms-of-use
  x-logo:
    url: https://theme.zdassets.com/theme_assets/56104/04e93064d309f75d054b8cee885d1ea51e9be8f7.png
    backgroundColor: '#FFFFFF'
    altText: Kantata OX API Documentation
    href: https://developer.kantata.com
servers:
- url: https://api.mavenlink.com/api/v1
tags:
- name: Holidays
  description: Holidays are the company-wide days off that have been added to a user's Kantata OX account.
paths:
  /holidays:
    get:
      summary: Fetching a list of Holidays
      description: '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.'
      operationId: Get Holidays
      tags:
      - Holidays
      parameters:
      - in: query
        name: include
        description: '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.'
        schema:
          type: string
      - in: query
        name: matching
        description: Includes holidays matching the specified name.
        schema:
          type: string
      - in: query
        name: not_on_calendars
        description: Includes holidays not specified in the comma separated list of calendar IDs.
        schema:
          type: string
      - in: query
        name: only
        description: '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`.'
        schema:
          type: string
      - in: query
        name: optional_fields
        description: Allows you to request one or more optional fields as an array.
        schema:
          type: array
          items:
            type: string
            enum:
            - calendar_names_list
      - in: query
        name: order
        description: '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`.'
        schema:
          type: string
          default: start_date:asc
      - in: query
        name: page
        schema:
          type: integer
          format: int32
          default: 1
      - in: query
        name: per_page
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 200
      responses:
        '200':
          description: A list of Holidays have been retrieved.
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    format: int32
                  meta:
                    type: object
                    properties:
                      count:
                        type: integer
                        format: int32
                      page_count:
                        type: integer
                        format: int32
                      page_number:
                        type: integer
                        format: int32
                      page_size:
                        type: integer
                        format: int32
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                        id:
                          type: string
                  holidays:
                    type: object
                    additionalProperties:
                      $ref: '#/components/schemas/Holiday'
                  holiday_calendar_associations:
                    type: object
                    additionalProperties:
                      $ref: '#/components/schemas/HolidayCalendarAssociation'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Page Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '503':
          description: Service is unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    post:
      summary: Creating a new Holiday
      description: '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.'
      operationId: Create Holiday
      tags:
      - Holidays
      parameters:
      - in: query
        name: include
        description: '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.'
        schema:
          type: string
      - in: query
        name: optional_fields
        description: Allows you to request one or more optional fields as an array.
        schema:
          type: array
          items:
            type: string
            enum:
            - calendar_names_list
      responses:
        '200':
          description: Holiday has been created.
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    format: int32
                  meta:
                    type: object
                    properties:
                      count:
                        type: integer
                        format: int32
                      page_count:
                        type: integer
                        format: int32
                      page_number:
                        type: integer
                        format: int32
                      page_size:
                        type: integer
                        format: int32
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                        id:
                          type: string
                  holidays:
                    type: object
                    additionalProperties:
                      $ref: '#/components/schemas/Holiday'
                  holiday_calendar_associations:
                    type: object
                    additionalProperties:
                      $ref: '#/components/schemas/HolidayCalendarAssociation'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Page Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '503':
          description: Service is unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                holiday:
                  type: object
                  properties:
                    name:
                      type: string
                      description: The name of the holiday.
                    start_date:
                      type: string
                      format: date
                      description: The date the holiday begins. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
                    end_date:
                      type: string
                      format: date
                      description: The date the holiday ends. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
                    paid:
                      type: boolean
                      description: Whether this time range is considered paid time off.
                    holiday_calendar_ids:
                      type: array
                      items:
                        type: integer
                        format: int32
                      description: The calendars to which this holiday belongs.
                  required:
                  - name
                  - start_date
        required: true
  /holidays/{id}:
    get:
      summary: Fetching a single Holiday
      description: '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.'
      operationId: Get Holiday
      tags:
      - Holidays
      parameters:
      - in: path
        name: id
        required: true
        description: The ID of the Model.
        schema:
          type: integer
      - in: query
        name: include
        description: '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.'
        schema:
          type: string
      - in: query
        name: optional_fields
        description: Allows you to request one or more optional fields as an array.
        schema:
          type: array
          items:
            type: string
            enum:
            - calendar_names_list
      responses:
        '200':
          description: The Holiday has been retrieved.
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    format: int32
                  meta:
                    type: object
                    properties:
                      count:
                        type: integer
                        format: int32
                      page_count:
                        type: integer
                        format: int32
                      page_number:
                        type: integer
                        format: int32
                      page_size:
                        type: integer
                        format: int32
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                        id:
                          type: string
                  holidays:
                    type: object
                    additionalProperties:
                      $ref: '#/components/schemas/Holiday'
                  holiday_calendar_associations:
                    type: object
                    additionalProperties:
                      $ref: '#/components/schemas/HolidayCalendarAssociation'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Page Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '503':
          description: Service is unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    put:
      summary: Updating an existing Holiday
      description: '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.'
      operationId: Update Holiday
      tags:
      - Holidays
      parameters:
      - in: path
        name: id
        required: true
        description: The ID of the Model.
        schema:
          type: integer
      - in: query
        name: include
        description: '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.'
        schema:
          type: string
      - in: query
        name: optional_fields
        description: Allows you to request one or more optional fields as an array.
        schema:
          type: array
          items:
            type: string
            enum:
            - calendar_names_list
      responses:
        '200':
          description: Holiday has been updated.
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    format: int32
                  meta:
                    type: object
                    properties:
                      count:
                        type: integer
                        format: int32
                      page_count:
                        type: integer
                        format: int32
                      page_number:
                        type: integer
                        format: int32
                      page_size:
                        type: integer
                        format: int32
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                        id:
                          type: string
                  holidays:
                    type: object
                    additionalProperties:
                      $ref: '#/components/schemas/Holiday'
                  holiday_calendar_associations:
                    type: object
                    additionalProperties:
                      $ref: '#/components/schemas/HolidayCalendarAssociation'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Page Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '503':
          description: Service is unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                holiday:
                  type: object
                  properties:
                    name:
                      type: string
                      description: The name of the holiday.
                    start_date:
                      type: string
                      format: date
                      description: The date the holiday begins. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
                    end_date:
                      type: string
                      format: date
                      description: The date the holiday ends. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
                    paid:
                      type: boolean
                      description: Whether this time range is considered paid time off.
                    holiday_calendar_ids:
                      type: array
                      items:
                        type: integer
                        format: int32
                      description: The calendars to which this holiday belongs.
                  required:
                  - name
                  - start_date
        required: true
    delete:
      summary: Deleting an existing Holiday
      description: 'The response will contain no content and an HTTP 204 status code if the request was

        successful, or a standard Kantata OX error message explaining why the object could not be deleted.'
      operationId: Delete Holiday
      tags:
      - Holidays
      parameters:
      - in: path
        name: id
        required: true
        description: The ID of the Model.
        schema:
          type: integer
      responses:
        '204':
          description: Holiday has been deleted.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Page Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '503':
          description: Service is unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
components:
  schemas:
    Holiday:
      title: Holiday
      description: A holiday is a day (or range of days) representing company-wide time off. Holidays are associated with a calendar for scheduling purposes.".
      type: object
      properties:
        calendar_names_list:
          type: string
          description: 'A comma separated list of calendar names to which the holiday belongs.

            Only returned when requested through the optional_fields param.'
        end_date:
          type: string
          format: date
          description: The date the holiday ends.
        holiday_calendar_association_ids:
          type: array
          items:
            type: string
          description: '`holiday_calendar_association_ids` will only be included in the response if `holiday_calendar_associations` is in the list of included associations. See <a href=''#section/Includes''>include</a> section for usage.'
        name:
          type: string
          description: The name of the holiday.
        paid:
          type: boolean
          description: Whether the holiday is paid.
        start_date:
          type: string
          format: date
          description: The date the holiday begins.
        total_hours:
          type: integer
          format: int32
          description: The number of workweek hours that the holiday includes.
    HolidayCalendarAssociation:
      title: Holiday Calendar Association
      description: 'A Holiday Calendar Association represents the relationship between Holiday objects and Holiday Calendar objects.

        A Holiday can be associated with several different Holiday Calendars.

        To associate a Holiday with a Holiday Calendar create a Holiday Calendar Assocation.'
      type: object
      properties:
        holiday_calendar_id:
          type: string
          description: '`holiday_calendar_id` will only be included in the response if `holiday_calendar` is in the list of included associations. See <a href=''#section/Includes''>include</a> section for usage.'
        holiday_calendar_name:
          type: string
          description: Returns the name of the associated Holiday Calendar.
        holiday_id:
          type: string
          description: '`holiday_id` will only be included in the response if `holiday` is in the list of included associations. See <a href=''#section/Includes''>include</a> section for usage.'
        holiday_name:
          type: string
          description: Returns the name of the associated Holiday.
    Errors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
    Error:
      type: object
      properties:
        type:
          type: string
        message:
          type: string
  securitySchemes:
    BearerToken:
      type: apiKey
      name: Bearer
      in: header
    OauthSecurity:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: https://app.mavenlink.com/oauth/authorize
          tokenUrl: https://app.mavenlink.com/oauth/token
x-tagGroups:
- name: '# Subscribed Events'
  tags:
  - Event Types
  - Events
- name: Account Locations
  tags:
  - Account Locations
- name: Account Settings & Members
  tags:
  - Access Group Memberships
  - Account Colors
  - Account Invitations
  - Account Memberships
  - Backup Approver Associations
  - Billable Utilizations
  - Cost Rates
  - Custom Branding
  - Organization Memberships
  - Organizations
  - Roles
  - Skill Categories
  - Skill Memberships
  - Skills
  - Task Status Sets
  - Task Statuses
  - User Group Memberships
  - Users
- name: Currencies
  tags:
  - Currencies
- name: Custom Fields
  tags:
  - Custom Field Choices
  - Custom Field Sets
  - Custom Field Values
  - Custom Fields
- name: Data Exporter
  tags:
  - Data Export Schema
  - Data Exports
- name: Estimates
  tags:
  - Estimate Scenario Resource Allocations
  - Estimate Scenario Resources
  - Estimate Scenarios
  - Estimates
- name: Expense Budgets
  tags:
  - Expense Budgets
- name: Expense Tracking
  tags:
  - Attachments
  - Expense Categories
  - Expense Report Submissions
  - Expenses
  - Vendors
- name: External References
  tags:
  - External References
- name: Financials
  tags:
  - Billing Milestones
  - Revenue Recognition Methods
- name: Foreign Exchange
  tags:
  - Exchange Tables
- name: Insights & Analytics
  tags:
  - Insights Access Group Memberships
  - Insights Dynamic Dashboards
  - Insights Report Exports
  - Insights Reports
- name: Invoices
  tags:
  - Client Invoice Defaults
  - External Payments
  - Invoices
  - Workspace Invoice Preferences
- name: Personal Settings
  tags:
  - Users
- name: Posts & Replies
  tags:
  - Attachments
  - Posts
  - User File Associations
- name: Project Snapshots
  tags:
  - Project Snapshots
- name: Project Templates
  tags:
  - Project Template Additional Tabs
  - Project Template Assignments
  - Project Template Expense Budgets
  - Project Templates
- name: Projects
  tags:
  - Participations
  - Project Accounting Records
  - Status Reports
  - Workspace Allocations
  - Workspace Baselines
  - Workspace Groups
  - Workspace Invoice Preferences
  - Workspace Resource Skills
  - Workspace Resources
  - Workspace Status Changes
  - Workspace Task Status Sets
  - Workspaces
- name: Rate Cards
  tags:
  - Activations
  - Rate Card Role (Rate for a Role)
  - Rate Card Set Version (Effective version by Date)
  - Rate Card Sets (Group of Rate Cards)
  - Rate Card Table Rows
  - Rate Card Versions
  - Rate Cards (Multiple Currencies)
- name: Recommendations
  tags:
  - Recommendations
- name: Resource Requests
  tags:
  - Resource Requests
- name: Scheduling
  tags:
  - Holiday Calendar Associations
  - Holiday Calendar Memberships
  - Holiday Calendars
  - Holidays
  - Time Off Entries
  - Workweek Memberships
  - Workweeks
- name: Surveys (Legacy)
  tags:
  - Survey Answers (Legacy)
  - Survey Questions (Legacy)
  - Survey Templates (Legacy)
  - Surveys Responses (Legacy)
- name: Tasks
  tags:
  - Assignments
  - Daily Scheduled Hours (Story Allocation Days)
  - Followers
  - Stories
  - Story Dependencies
  - Story State Changes
  - Story Tasks
- name: Time Tracking
  tags:
  - Line Item Locks
  - Time Entries
  - Timesheet Approvals
  - Timesheet Cancellations
  - Timesheet Rejections
  - Timesheet Submissions