Business info
Holidays
Get the business’s defined holidays, with an optional date range filter
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 thefrom and to parameters.
It is read-only and is automatically scoped to the company of the API Key used.
Authentication header
Your Mindo API Key. Format:
mindo_xxxxxxxxxxxxxxxxxxxxxxxxQuery parameters
Start date (
YYYY-MM-DD format, inclusive). Filters holidays with a date greater than or equal to this value.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.Internal holiday ID.
Company ID.
Holiday name.
Holiday description.
Holiday date (
YYYY-MM-DD format).IDs of the branches the holiday applies to. Empty means it applies to all branches.
Details of the branches the holiday applies to.
Who the holiday applies to. Possible values:
VIRTUAL_ATTENTION (virtual service), BRANCH (branch), ALL_BRANCHES (all branches), ALL (everyone).If
true, the holiday has reduced hours (startTime/finishAt) instead of a full closure.Start time of the special hours (
HH:MM:SS format). null if there are no special hours.End time of the special hours (
HH:MM:SS format). null if there are no special hours.Whether the holiday is active.
Creation date (ISO 8601).
Last update date (ISO 8601).

