Business Hours
List business hours schedules in an organization with pagination.
ApiKeyAuthAuthorization<token>application/json- response
data*curl -X GET 'https://dev.dixa.io/v1/business-hours/schedules' \ -H 'Authorization: <API token>'Get a business hours schedule definition in an organization by providing its ID.
ApiKeyAuthAuthorization<token>scheduleId*stringuuidapplication/json- response
data*curl -X GET 'https://dev.dixa.io/v1/business-hours/schedules/{scheduleId}/definition' \ -H 'Authorization: <API token>'Get the resolved business hours schedule for the next number of days, applying recurring rules and exceptions. Each entry in businessHours describes one upcoming day (see its nextDate). An entry with status: Open lists the intervals during which the business is open on that day; between and outside those intervals it is closed. An entry with status: Closed is a day explicitly configured as closed and has no intervals. Days without any configured business hours are omitted from the response entirely, so businessHours can be empty when no day in the requested window has configured hours. In short: the business is open only during the intervals of status: Open entries, and closed at all other times.
ApiKeyAuthAuthorization<token>scheduleId*stringuuiddays?integerNumber of upcoming days to include in the response. Must be between 1 and 90.
int321 <= value <= 907application/json- response
data*curl -X GET 'https://dev.dixa.io/v1/business-hours/schedules/{scheduleId}/upcoming' \ -H 'Authorization: <API token>'Check if a business is open either right now or at the specified timestamp. When the business is open, closesAt holds the end of the current open interval and opensAt is null. When it is closed, opensAt holds the start of the next open interval — if there is one within the next year — and closesAt is null.
ApiKeyAuthAuthorization<token>scheduleId*stringtimestamp?stringAn optional timestamp in ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z' to check if the business is open at a specific time. If not specified, the current time is used.
date-timeThe business hours status
application/json- response
data*curl -X GET 'https://dev.dixa.io/v1/business-hours/schedules/{scheduleId}/status' \ -H 'Authorization: <API token>'