Business Hours

Check if a business is open

Check if a business is open either right now or at the specified timestamp.

SecurityApiKeyAuth

Request

path Parameters

scheduleId

required

string

query Parameters

timestamp

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

Responses

200

The business hours status

400

Invalid value for: query parameter timestamp, Invalid value extracted from request context

500

Internal failure during request processing

get/v1/business-hours/schedules/{scheduleId}/status

Request samples

Response samples

200
400
500

application/json

{"data": {"isOpen": true,
"timestamp": "2024-12-12T14:04:18.962551784Z[Etc/UTC]"
}
}

List business hours schedules

List business hours schedules in an organization with pagination.

SecurityApiKeyAuth

Responses

200

400

Invalid value extracted from request context

500

Internal failure during request processing

get/v1/business-hours/schedules

Request samples

Response samples

200
400
500

application/json

{"data": {"schedules": [{"name": "Schedule 1",
"id": "b462107a-0a67-19f6-bfc0-207012e0190f"
},
{"name": "Schedule 2",
"id": "f462107a-0a57-66f6-dac0-207012e01255"
},
{"name": "Schedule 3",
"id": "e462107a-0f23-44f6-48b3-207012e0184e"
}
]
}
}

Business Hours

Check if a business is open

path Parameters

query Parameters

List business hours schedules

Why Dixa

Product

Capabilities

Resources

Solutions

Company