Business Hours
Retrieve a list of defined business hours, showcasing their names, and other information.
Limits the number of results to return
10
Pagination token that keeps of track of the current position in the list
Order in which to retrieve the results
false
GET /workspaces/{workspaceId}/business-hours HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"results": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"timezone": "text",
"weeklySchedule": {
"monday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"tuesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"wednesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"thursday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"friday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"saturday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"sunday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
}
},
"holidays": [
{
"name": "text",
"day": 1,
"month": 1
}
],
"assignedTeamIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"createdAt": "2025-07-03T02:20:24.599Z",
"updatedAt": "2025-07-03T02:20:24.599Z"
}
]
}
Define and create new business hours, specifying the name, schedule.
POST /workspaces/{workspaceId}/business-hours HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 656
{
"name": "text",
"description": "text",
"timezone": "text",
"weeklySchedule": {
"monday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"tuesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"wednesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"thursday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"friday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"saturday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"sunday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
}
},
"holidays": [
{
"name": "text",
"day": 1,
"month": 1
}
],
"assignedTeamIds": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
No content
Retrieve information about specific business hours, including their name, schedule.
Business Hours entry UUID
GET /workspaces/{workspaceId}/business-hours/{businessHourId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"timezone": "text",
"weeklySchedule": {
"monday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"tuesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"wednesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"thursday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"friday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"saturday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"sunday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
}
},
"holidays": [
{
"name": "text",
"day": 1,
"month": 1
}
],
"assignedTeamIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"createdAt": "2025-07-03T02:20:24.599Z",
"updatedAt": "2025-07-03T02:20:24.599Z"
}
Modify the details of specific business hours, such as their name, schedule.
Business Hours entry UUID
PATCH /workspaces/{workspaceId}/business-hours/{businessHourId} HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 656
{
"name": "text",
"description": "text",
"timezone": "text",
"weeklySchedule": {
"monday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"tuesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"wednesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"thursday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"friday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"saturday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"sunday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
}
},
"holidays": [
{
"name": "text",
"day": 1,
"month": 1
}
],
"assignedTeamIds": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"timezone": "text",
"weeklySchedule": {
"monday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"tuesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"wednesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"thursday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"friday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"saturday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"sunday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
}
},
"holidays": [
{
"name": "text",
"day": 1,
"month": 1
}
],
"assignedTeamIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"createdAt": "2025-07-03T02:20:24.599Z",
"updatedAt": "2025-07-03T02:20:24.599Z"
}
Remove specific business hours, permanently deleting their defined schedule.
Business Hours entry UUID
DELETE /workspaces/{workspaceId}/business-hours/{businessHourId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
No content
Determine if the current time falls within the defined business hours, providing information on availability.
Business Hours entry UUID
GET /workspaces/{workspaceId}/business-hours/{businessHourId}/check HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"isOpen": true
}
Last updated
Was this helpful?