Skip to content
Dixa API/
/
Check if a business is op...

Check if a business is open

Request

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.

Security
ApiKeyAuth
Path
scheduleIdstringrequired
Query
timestampstring, (date-time)

An 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.

GET
/beta/business-hours/schedules/{scheduleId}/status
curl -i -X GET \
  'https://dev.dixa.io/beta/business-hours/schedules/{scheduleId}/status?timestamp=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The business hours status

Bodyapplication/json
dataobject(GetBusinessOpenStatusResult)required
Response
{
  "data": {
    "isOpen": true,
    "timestamp": "2025-01-08T08:31:25Z",
    "closesAt": "2025-01-08T17:00:00Z"
  }
}