Skip to content
/Business Hours

Dixa API (beta)

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server
https://docs.dixa.io/_mock/openapi/dixa-api/beta
https://dev.dixa.io

Analytics

Operations

Agents

Operations

End Users

Operations

Chatbots

Operations

Anonymization

Operations

Custom Attributes

Operations

Teams

Operations

Conversations

Operations

Messages

Operations

Internal Notes

Operations

Ratings

Operations

Tags

Operations

Queues

Operations

Contact Endpoints

Operations

Webhooks

Operations

Templates

Operations

Business Hours

Operations

List business hours schedules

Request

List business hours schedules in an organization with pagination.

Security
ApiKeyAuth
curl -i -X GET \
  https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/business-hours/schedules \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataobject(ListBusinessHoursSchedulesResult)required
data.​schedulesArray of objects(BusinessHoursSchedule)
Response
application/json
{
  "data": {
    "schedules": [ … ]
  }
}

Check if a business is open

Request

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

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.

curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/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
data.​isOpenbooleanrequired
data.​timestampstring(date-time)required
Response
application/json
{
  "data": {
    "isOpen": true,
    "timestamp": "2025-01-08T08:31:25Z"
  }
}

Knowledge

Operations

Organization

Operations