> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Zoho CRM: README

> Retrieve holidays. Zoho CRM Holidays Get Holidays reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.

Retrieve holidays.

<Info>
  Tool ID: `zoho_crm_holidays_get_holidays`
</Info>

## Run this action

This action has conditional or dynamic input fields that cannot be represented by a reliable static example.

Inspect the live contract before executing it:

```bash theme={null}
deepline tools get zoho_crm_holidays_get_holidays --json
```

## Example response

The static output schema is not detailed enough to generate a reliable example. Use `deepline tools get zoho_crm_holidays_get_holidays --json` for the complete live contract.

## Input reference

Retrieves a list of holidays filtered by year, type (business or shift), and shift ID. Business holidays apply organization-wide, while shift holidays are specific to configured shifts. Returns paginated results with metadata.

| Name               | Type                                    | Required | Default | Details                                                                                                                                                                                  |
| ------------------ | --------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.year`     | `integer`                               | No       | —       | Filter holidays by year. Must be a valid 4-digit year value within a reasonable range. Format: `int32`. Minimum: 2000. Maximum: 2100.                                                    |
| `payload.type`     | `"business_holiday" \| "shift_holiday"` | No       | —       | Filter holidays by type: business holidays apply to all users, shift holidays apply to specific shifts Allowed: `business_holiday`, `shift_holiday`.                                     |
| `payload.shift_id` | `string`                                | No       | —       | Filter holidays by shift hour ID. Required when filtering by shift\_holiday type. Must be a valid numeric string identifier. Minimum length: 1. Maximum length: 30. Pattern: `^[0-9]+$`. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Retrieves a list of holidays filtered by year, type (business or shift), and shift ID. Business holidays apply organization-wide, while shift holidays are specific to configured shifts. Returns paginated results with metadata.",
    "properties": {
      "year": {
        "type": "integer",
        "description": "Filter holidays by year. Must be a valid 4-digit year value within a reasonable range.",
        "minimum": 2000,
        "maximum": 2100,
        "format": "int32"
      },
      "type": {
        "type": "string",
        "description": "Filter holidays by type: business holidays apply to all users, shift holidays apply to specific shifts",
        "enum": [
          "business_holiday",
          "shift_holiday"
        ]
      },
      "shift_id": {
        "type": "string",
        "description": "Filter holidays by shift hour ID. Required when filtering by shift_holiday type. Must be a valid numeric string identifier.",
        "minLength": 1,
        "maxLength": 30,
        "pattern": "^[0-9]+$"
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name                                     | Type                                    | Required | Default | Details                                                                                                                                          |
| ---------------------------------------- | --------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `result.data`                            | `object`                                | Yes      | —       | The Response body of the object.                                                                                                                 |
| `result.data.holidays`                   | `array`                                 | Yes      | —       | Array of holiday objects matching the filter criteria Maximum items: 100.                                                                        |
| `result.data.holidays[].name`            | `string`                                | Yes      | —       | Name of the holiday. Cannot contain special characters: #, %, ^, &, \* Minimum length: 1. Maximum length: 80. Pattern: `^[^#%^&*]+$`.            |
| `result.data.holidays[].date`            | `string`                                | Yes      | —       | Date of the holiday in YYYY-MM-DD format. Must be within current or next financial year. Format: `date`.                                         |
| `result.data.holidays[].type`            | `"business_holiday" \| "shift_holiday"` | Yes      | —       | Type of holiday: business\_holiday applies to all users, shift\_holiday applies to specific shifts Allowed: `business_holiday`, `shift_holiday`. |
| `result.data.holidays[].shift_hour`      | `object \| null`                        | Yes      | —       | Shift hour configuration associated with this holiday (required for shift\_holiday type)                                                         |
| `result.data.holidays[].shift_hour.name` | `string`                                | Yes      | —       | Name of the shift hour Maximum length: 255.                                                                                                      |
| `result.data.holidays[].shift_hour.id`   | `string`                                | Yes      | —       | Unique identifier of the shift hour Maximum length: 255. Pattern: `^[0-9]+$`.                                                                    |
| `result.data.holidays[].id`              | `string`                                | Yes      | —       | Unique identifier of the holiday Maximum length: 255. Pattern: `^[0-9]+$`.                                                                       |
| `result.data.holidays[].year`            | `integer`                               | Yes      | —       | Year of the holiday Format: `int32`. Minimum: 2000. Maximum: 2100.                                                                               |
| `result.data.info`                       | `object`                                | No       | —       | Pagination metadata for the response                                                                                                             |
| `result.data.info.per_page`              | `integer`                               | No       | —       | Number of records returned per page Format: `int32`. Minimum: 1.                                                                                 |
| `result.data.info.page`                  | `integer`                               | No       | —       | Current page number (1-indexed) Format: `int32`. Minimum: 1.                                                                                     |
| `result.data.info.count`                 | `integer`                               | No       | —       | Total number of records returned in this response Format: `int32`. Minimum: 0.                                                                   |
| `result.data.info.more_records`          | `boolean`                               | No       | —       | Indicates whether more records are available on subsequent pages                                                                                 |
| `result.meta`                            | `object`                                | No       | —       | Additional response metadata (status, paging).                                                                                                   |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "The Response body of the object.",
        "properties": {
          "holidays": {
            "type": "array",
            "description": "Array of holiday objects matching the filter criteria",
            "maxItems": 100,
            "items": {
              "type": "object",
              "description": "The Item of the object.",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Name of the holiday. Cannot contain special characters: #, %, ^, &, *",
                  "minLength": 1,
                  "maxLength": 80,
                  "pattern": "^[^#%^&*]+$"
                },
                "date": {
                  "type": "string",
                  "description": "Date of the holiday in YYYY-MM-DD format. Must be within current or next financial year.",
                  "format": "date"
                },
                "type": {
                  "type": "string",
                  "description": "Type of holiday: business_holiday applies to all users, shift_holiday applies to specific shifts",
                  "enum": [
                    "business_holiday",
                    "shift_holiday"
                  ]
                },
                "shift_hour": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "description": "Shift hour configuration associated with this holiday (required for shift_holiday type)",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Name of the shift hour",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "Unique identifier of the shift hour",
                      "maxLength": 255,
                      "pattern": "^[0-9]+$"
                    }
                  },
                  "required": [
                    "name",
                    "id"
                  ],
                  "additionalProperties": false
                },
                "id": {
                  "type": "string",
                  "description": "Unique identifier of the holiday",
                  "maxLength": 255,
                  "pattern": "^[0-9]+$"
                },
                "year": {
                  "type": "integer",
                  "description": "Year of the holiday",
                  "minimum": 2000,
                  "maximum": 2100,
                  "format": "int32"
                }
              },
              "required": [
                "name",
                "date",
                "type",
                "shift_hour",
                "id",
                "year"
              ],
              "additionalProperties": false
            }
          },
          "info": {
            "type": "object",
            "description": "Pagination metadata for the response",
            "properties": {
              "per_page": {
                "type": "integer",
                "description": "Number of records returned per page",
                "minimum": 1,
                "format": "int32"
              },
              "page": {
                "type": "integer",
                "description": "Current page number (1-indexed)",
                "minimum": 1,
                "format": "int32"
              },
              "count": {
                "type": "integer",
                "description": "Total number of records returned in this response",
                "minimum": 0,
                "format": "int32"
              },
              "more_records": {
                "type": "boolean",
                "description": "Indicates whether more records are available on subsequent pages"
              }
            },
            "additionalProperties": false
          }
        },
        "required": [
          "holidays"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)