Skip to main content
GET

Description

This endpoint returns the business’s defined holidays (full-closure days or reduced-hours days). It supports an optional date range filter via the from and to parameters. It is read-only and is automatically scoped to the company of the API Key used.

Authentication header

string
required
Your Mindo API Key. Format: mindo_xxxxxxxxxxxxxxxxxxxxxxxx

Query parameters

string
Start date (YYYY-MM-DD format, inclusive). Filters holidays with a date greater than or equal to this value.
string
End date (YYYY-MM-DD format, inclusive). Filters holidays with a date less than or equal to this value.

Response

Returns an array of holidays.
integer
Internal holiday ID.
integer
Company ID.
string
Holiday name.
string
Holiday description.
string
Holiday date (YYYY-MM-DD format).
array
IDs of the branches the holiday applies to. Empty means it applies to all branches.
array
Details of the branches the holiday applies to.
string
Who the holiday applies to. Possible values: VIRTUAL_ATTENTION (virtual service), BRANCH (branch), ALL_BRANCHES (all branches), ALL (everyone).
boolean
If true, the holiday has reduced hours (startTime/finishAt) instead of a full closure.
string
Start time of the special hours (HH:MM:SS format). null if there are no special hours.
string
End time of the special hours (HH:MM:SS format). null if there are no special hours.
boolean
Whether the holiday is active.
string
Creation date (ISO 8601).
string
Last update date (ISO 8601).