Zoho: Holidays — holidays get Holidays

← Holidays operations · Get started

Operation zoho.getholidays

Provider route: GET /crm/v8/settings/holidays. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["holidays"]["getHolidays"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.holidays.getHolidays(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.holidays.get_holidays(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.year	integer	Optional	The Year of the object. Format: int32 Maximum: 2100 Minimum: 2000
query.type	string	Optional	The Type of the object. One of: business_holiday, shift_holiday
query.shift_id	string	Optional	The Shift id of the object. Maximum length: 30 Minimum length: 1 Pattern: ^[0-9]+$
query.page	integer	Optional	Format: int32 Minimum: 1

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Represents the response body containing the list of holidays and pagination metadata. Additional keys: not allowed
$ (anyOf 1).holidays	array	Required within parent	Contains the list of holidays matching the specified filter criteria. Maximum items: 100
$ (anyOf 1).holidays[]	object	Each item	Represents a single holiday record in the response. Additional keys: not allowed
$ (anyOf 1).holidays[].date	string	Required within parent	Represents the date of the holiday in YYYY-MM-DD format. Format: date
$ (anyOf 1).holidays[].id	string	Required within parent	Represents the unique identifier of the holiday record. Maximum length: 255 Pattern: ^[0-9]+$
$ (anyOf 1).holidays[].name	string	Required within parent	Represents the name of the holiday. Maximum length: 80 Minimum length: 1 Pattern: ^[^#%^&*]+$
$ (anyOf 1).holidays[].shift_hour	JSON	Required within parent
$ (anyOf 1).holidays[].shift_hour (anyOf 1)	object	Alternative	Represents the shift hour associated with this holiday. Contains null for business holidays. Additional keys: not allowed
$ (anyOf 1).holidays[].shift_hour (anyOf 1).id	string	Required within parent	Represents the unique identifier of the shift hour. Always present when the shift_hour object is included in the response. Maximum length: 255 Pattern: ^[0-9]+$
$ (anyOf 1).holidays[].shift_hour (anyOf 1).name	string	Required within parent	Represents the name of the shift hour. Always present when the shift_hour object is included in the response. Maximum length: 255
$ (anyOf 1).holidays[].shift_hour (anyOf 2)	null	Alternative	Represents the shift hour associated with this holiday. Contains null for business holidays. Additional keys: not allowed
$ (anyOf 1).holidays[].shift_hour (anyOf 2).id	string	Required within parent	Represents the unique identifier of the shift hour. Always present when the shift_hour object is included in the response. Maximum length: 255 Pattern: ^[0-9]+$
$ (anyOf 1).holidays[].shift_hour (anyOf 2).name	string	Required within parent	Represents the name of the shift hour. Always present when the shift_hour object is included in the response. Maximum length: 255
$ (anyOf 1).holidays[].type	string	Required within parent	The type of holiday that you want to fetch. The possible values are business_holiday and shift_holiday. Known values: business_holiday, shift_holiday
$ (anyOf 1).holidays[].year	JSON	Required within parent
$ (anyOf 1).holidays[].year (anyOf 1)	integer	Alternative	Represents the year in which the holiday falls. Format: int32 Maximum: 2100 Minimum: 2000
$ (anyOf 1).holidays[].year (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).info	object	Optional	Contains pagination metadata for the response. Additional keys: not allowed
$ (anyOf 1).info.count	JSON	Optional
$ (anyOf 1).info.count (anyOf 1)	integer	Alternative	Represents the total number of holiday records returned in this page of results. Format: int32 Minimum: 0
$ (anyOf 1).info.count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).info.more_records	boolean	Optional	Indicates whether more holiday records are available on subsequent pages.
$ (anyOf 1).info.page	JSON	Optional
$ (anyOf 1).info.page (anyOf 1)	integer	Alternative	Represents the current page number in the paginated results. Page numbers begin at one. Format: int32 Minimum: 1
$ (anyOf 1).info.page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).info.per_page	JSON	Optional
$ (anyOf 1).info.per_page (anyOf 1)	integer	Alternative	Represents the number of holiday records returned per page. Format: int32 Minimum: 1
$ (anyOf 1).info.per_page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: zoho.getholidays. Catalog operation: getHolidays. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

No-content response statuses: [204]

Official provider source