--- updatedAt: 2026-09-04T07:06:48.000Z agentTools: projectIndex: https://documentation.indigitall.com/llms.txt --- # Get special days schedule by ID Retrieve information about a specific special days schedule for the contact center of a given application. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "version": "2.0.0", "title": "INDIGITALL API", "x-logo": { "url": "https://console.indigitall.com/images/logo_verdeblanco@2x.png", "backgroundColor": "#0F3B7A" }, "description": "\n### Introduction:\nThis documentation describes every endpoint of Indigitall's API v2\n\nAPI BASE URL: https://api.indigitall.com/v2\n\n### Authentication:\n\nMost of the endpoints of the API needs an Authorization header.\n\nThere are two Authorization ways:\n\n- If your intention is to manage API calls with a server-side script you have to create a Server key through Indigitall's console.\n\n You can set the following Authorization Header : 'Authorization: ServerKey {ServerKey}'\n- If your intention is to integrate this API for front-end users POST /auth endpoint authorizes a user and returns an access token.\n\n You can set the following Authorization Header : 'Authorization: Bearer {Token}'\n" }, "security": [ { "Authorization": [] } ], "tags": [ { "name": "chat-cc-special-days-schedule", "description": "Endpoints to manage Contact Center special days schedules for chat-service-v2", "x-displayName": "Chat - CC Special Days Schedule" } ], "x-tagGroups": [ { "name": "Chat Service", "tags": [ "chat-configuration", "chat-channel", "chat-contact", "chat-integration", "chat-task", "chat-campaign", "chat-send", "chat-multimedia", "chat-slicing", "chat-tag", "chat-contact-list", "chat-cc-agent", "chat-cc-permissions-profile", "chat-cc-weekly-schedule", "chat-cc-special-days-schedule", "chat-cc-conversation", "chat-cc-agent-group", "chat-cc-contact-comment", "chat-cc-form", "chat-stats", "chat-internal" ] }, { "name": "Customer Service", "tags": [ "customer-service-adviser", "customer-service-customer", "customer-service-customer-csv", "customer-service-customer-field", "customer-service-customer-journey", "customer-service-customer-journey-template", "customer-service-customer-journey-control", "customer-service-customer-send", "customer-service-stats", "customer-service-webhook-template", "customer-service-segment", "customer-service-audience", "customer-service-application", "customer-service-journeywaitqueue", "customer-service-task", "customer-service-cdpeventtype", "customer-service-cdpeventtypetemplate", "customer-service-internal" ] }, { "name": "Email Service", "tags": [ "es-configuration", "es-configurationDomain", "es-configurationDomainEmail", "es-footer", "es-audience", "es-contact", "es-category", "es-campaign", "es-campaign-block", "es-campaign block-column", "es-campaign-multimedia", "es-shipment", "es-attachment", "es-statistics", "es-webhook", "es-tasks" ] }, { "name": "InApp Service", "tags": [ "inapp-configuration", "inapp-campaign", "inapp-schema", "inapp-topic", "inapp-multimedia", "inapp-form", "inapp-stats", "inapp-audience", "inapp-task" ] }, { "name": "SMS Service", "tags": [ "sms-campaign", "sms-configuration", "sms-contact", "sms-send", "sms-stats", "sms-topic", "sms-cost", "sms-webhook", "sms-private" ] }, { "name": "Wallet Service", "tags": [ "wallet-project", "wallet-images", "wallet-tasks", "wallet-notifications", "wallet-template", "wallet-loyalty-pass", "wallet-loyalty-template", "wallet-offer-pass", "wallet-offer-template", "wallet-generic-pass", "wallet-generic-template" ] }, { "name": "Stats Service", "tags": [ "stats-service-chat", "stats-service-cs", "stats-service-report", "stats-service-wallet", "stats-service-meta" ] }, { "name": "ChatGen service", "tags": [ "icc-chatgen-gateway-agent", "icc-chatgen-gateway-api-tool", "icc-chatgen-gateway-configured-custom-tool", "icc-chatgen-gateway-conversation", "icc-chatgen-gateway-custom-tool", "icc-chatgen-gateway-document", "icc-chatgen-gateway-file", "icc-chatgen-gateway-instance-config", "icc-chatgen-gateway-router-agent-tool", "icc-chatgen-gateway-router-agent" ] }, { "name": "AI Assitant service", "tags": [ "ai-generator-campaign" ] }, { "name": "Meta Service", "tags": [ "meta-cloudapi", "meta-configuration", "meta-webhook", "meta-business", "meta-templates", "meta-upload" ] }, { "name": "Push Live Service", "tags": [ "push-live-configuration", "push-live-ios-class", "push-live-activity", "push-live-send" ] }, { "name": "Pathbot", "tags": [ "pathbot-agents", "pathbot-applications", "pathbot-documents", "pathbot-flows", "pathbot-tools", "pathbot-nodes", "pathbot-ingestion-sources", "pathbot-evaluation", "pathbot-skills" ] }, { "name": "Link Service", "tags": [ "link-short-domain" ] } ], "servers": [ { "url": "https://api.indigitall.com/v2" } ], "paths": { "/chat/{applicationId}/contactCenter/specialDaysSchedule/{specialDaysScheduleId}": { "get": { "tags": [ "chat-cc-special-days-schedule" ], "summary": "Get special days schedule by ID", "description": "Retrieve information about a specific special days schedule for the contact center of a given application.", "x-eov-operation-handler": "ccSpecialDaysSchedule.controller", "x-gateway-endpoint": "chatServiceV2", "operationId": "getSpecialDaysScheduleById", "x-gateway-check-permission": { "account-features": [ "CHAT_V2_ENABLED" ] }, "parameters": [ { "$ref": "#/components/parameters/CHS_ApplicationId_PathParameter" }, { "$ref": "#/components/parameters/CHS_CcSpecialDaysSchedule_Id_PathParameter" } ], "responses": { "200": { "$ref": "#/components/responses/CHS_CcSpecialDaysSchedule_Response" }, "400": { "$ref": "#/components/responses/CHS_BadRequest_Response" }, "403": { "$ref": "#/components/responses/CHS_Forbidden_Response" }, "404": { "$ref": "#/components/responses/CHS_NotFound_Response" }, "500": { "$ref": "#/components/responses/CHS_ServerError_Response" } } } } }, "components": { "securitySchemes": { "Authorization": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "Authorization for accesing endpoints , must be in one of the following format:\n- **Bearer {token}**\n- **ServerKey {key}**\n" } }, "schemas": { "CHS_Id_Property": { "type": "integer", "format": "int32", "minimum": 0, "description": "Identifier", "example": 1234 }, "CHS_ApplicationId_Property": { "type": "integer", "format": "int32", "minimum": 0, "description": "Application identifier", "example": 1234 }, "CHS_DateTime_Property": { "type": "string", "format": "date-time", "description": "Date and time", "example": "2021-08-25T15:00:00Z" }, "CHS_CcSpecialDaysSchedule_Schema": { "type": "object", "additionalProperties": false, "properties": { "id": { "$ref": "#/components/schemas/CHS_CcSpecialDaysSchedule_Id_Property" }, "createdAt": { "$ref": "#/components/schemas/CHS_CcSpecialDaysSchedule_CreatedAt_Property" }, "updatedAt": { "$ref": "#/components/schemas/CHS_CcSpecialDaysSchedule_UpdatedAt_Property" }, "applicationId": { "$ref": "#/components/schemas/CHS_ApplicationId_Property" }, "name": { "$ref": "#/components/schemas/CHS_CcSpecialDaysSchedule_Name_Property" }, "enabled": { "$ref": "#/components/schemas/CHS_CcSpecialDaysSchedule_Enabled_Property" }, "agentGroupId": { "$ref": "#/components/schemas/CHS_CcSpecialDaysSchedule_AgentGroupId_Property" }, "specialDays": { "$ref": "#/components/schemas/CHS_CcSpecialDaysSchedule_SpecialDays_Property" } } }, "CHS_CcSpecialDaysSchedule_Id_Property": { "allOf": [ { "description": "Special Days Schedule ID" }, { "$ref": "#/components/schemas/CHS_Id_Property" } ] }, "CHS_CcSpecialDaysSchedule_CreatedAt_Property": { "allOf": [ { "description": "Date and time when the special days schedule was created" }, { "$ref": "#/components/schemas/CHS_DateTime_Property" } ] }, "CHS_CcSpecialDaysSchedule_UpdatedAt_Property": { "allOf": [ { "description": "Date and time when the special days schedule was last updated" }, { "$ref": "#/components/schemas/CHS_DateTime_Property" } ] }, "CHS_CcSpecialDaysSchedule_AgentGroupId_Property": { "type": "integer", "nullable": true, "description": "The ID of the agent group associated with this special days schedule, if any.\n", "example": 123 }, "CHS_CcSpecialDaysSchedule_Name_Property": { "type": "string", "description": "The name of the special days schedule.\n", "example": "Holiday Overrides" }, "CHS_CcSpecialDaysSchedule_Enabled_Property": { "type": "boolean", "description": "Whether this special days schedule is enabled and active.\n", "example": true }, "CHS_CcSpecialDaysSchedule_DaySchedule_Property": { "type": "object", "additionalProperties": false, "required": [ "startTime", "endTime" ], "properties": { "startTime": { "type": "string", "pattern": "^([01]\\d|2[0-3]):([0-5]\\d)$", "description": "Start time in HH:MM format (24-hour)", "example": "09:00" }, "endTime": { "type": "string", "pattern": "^(([01]\\d|2[0-3]):([0-5]\\d)|24:00)$", "description": "End time in HH:MM format (24-hour), 24:00 allowed", "example": "18:00" } } }, "CHS_CcSpecialDaysSchedule_SpecialDay_Property": { "type": "object", "additionalProperties": false, "required": [ "day", "month", "schedule" ], "properties": { "day": { "type": "integer", "minimum": 1, "maximum": 31, "description": "Day of the month. Combined with month and optionally year to define the special day.\n", "example": 25 }, "month": { "type": "integer", "minimum": 1, "maximum": 12, "description": "Month of the year. Combined with day and optionally year to define the special day.\n", "example": 12 }, "year": { "type": "integer", "minimum": 1, "maximum": 9999, "description": "Optional year. If omitted, the special day recurs every year for the given day and month.\n", "example": 2026 }, "schedule": { "type": "array", "description": "Schedule ranges that override the weekly schedule for the matched special day. Empty array means closed.\n", "items": { "$ref": "#/components/schemas/CHS_CcSpecialDaysSchedule_DaySchedule_Property" } } } }, "CHS_CcSpecialDaysSchedule_SpecialDays_Property": { "type": "array", "description": "Special day overrides by day/month, optionally scoped to a specific year. If both a recurring day and a specific date match, the specific date takes precedence.\n", "items": { "$ref": "#/components/schemas/CHS_CcSpecialDaysSchedule_SpecialDay_Property" }, "example": [ { "day": 25, "month": 12, "schedule": [] }, { "day": 31, "month": 12, "year": 2026, "schedule": [ { "startTime": "10:00", "endTime": "14:00" } ] } ] } }, "responses": { "CHS_NotFound_Response": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "statusCode": { "type": "integer", "description": "Status code", "example": 404 }, "errorCode": { "type": "string", "description": "Error code", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "Error message", "example": "Resource not found." } } } } } }, "CHS_ServerError_Response": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "statusCode": { "type": "integer", "description": "Status code", "example": 500 }, "errorCode": { "type": "string", "description": "Error code", "example": "INTERNAL_SERVER_ERROR" }, "message": { "type": "string", "description": "Error message", "example": "Internal server error." } } } } } }, "CHS_Forbidden_Response": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "statusCode": { "type": "integer", "description": "Status code", "example": 403 }, "errorCode": { "type": "string", "description": "Error code", "example": "FORBIDDEN" }, "message": { "type": "string", "description": "Error message", "example": "Forbidden." } } } } } }, "CHS_BadRequest_Response": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "statusCode": { "type": "integer", "description": "Status code", "example": 400 }, "errorCode": { "type": "string", "description": "Error code", "example": "BAD_REQUEST" }, "message": { "type": "string", "description": "Error message", "example": "Bad request." } } } } } }, "CHS_CcSpecialDaysSchedule_Response": { "description": "Retrieve information about a specific special days schedule for the contact center of a given application.", "content": { "application/json": { "schema": { "required": [ "statusCode", "message", "data" ], "type": "object", "additionalProperties": false, "properties": { "statusCode": { "type": "integer", "description": "Status code", "example": 200 }, "message": { "type": "string", "description": "Response message, usually OK", "example": "OK" }, "data": { "$ref": "#/components/schemas/CHS_CcSpecialDaysSchedule_Schema" } } } } } } }, "parameters": { "CHS_ApplicationId_PathParameter": { "in": "path", "name": "applicationId", "required": true, "description": "Application's ID", "schema": { "type": "integer", "example": 123 } }, "CHS_CcSpecialDaysSchedule_Id_PathParameter": { "in": "path", "name": "specialDaysScheduleId", "required": true, "description": "Special days schedule ID", "schema": { "type": "integer", "example": 1 } } } } } ```