DocumentationEngagement Platform API
Sign inGet started
Guides
API

Business Hours

GET
/workspaces/{workspaceId}/business-hours
Retrieve a list of defined business hours, showcasing their names, and other information.
Paramètres de requête
limit
integer
Limits the number of results to return.
pageToken
string
The cursor that keeps track of the current position in the results.
reverse
boolean
Reverses the order in which the results are returned.
Corps de la réponse
results
array of object
obligatoire
Afficher les attributs enfants
results.id
string
obligatoire
results.name
string
obligatoire
results.description
string
results.timezone
string
obligatoire
results.weeklySchedule
object
obligatoire
Afficher les attributs enfants
results.weeklySchedule.monday
object
Afficher les attributs enfants
results.weeklySchedule.monday.from
object
obligatoire
Afficher les attributs enfants
results.weeklySchedule.monday.from.hour
integer
obligatoire
results.weeklySchedule.monday.from.minute
integer
results.weeklySchedule.monday.to
object
obligatoire
Afficher les attributs enfants
results.weeklySchedule.monday.to.hour
integer
obligatoire
results.weeklySchedule.monday.to.minute
integer
results.weeklySchedule.tuesday
object
Afficher les attributs enfants
results.weeklySchedule.tuesday.from
object
obligatoire
Afficher les attributs enfants
results.weeklySchedule.tuesday.from.hour
integer
obligatoire
results.weeklySchedule.tuesday.from.minute
integer
results.weeklySchedule.tuesday.to
object
obligatoire
Afficher les attributs enfants
results.weeklySchedule.tuesday.to.hour
integer
obligatoire
results.weeklySchedule.tuesday.to.minute
integer
results.weeklySchedule.wednesday
object
Afficher les attributs enfants
results.weeklySchedule.wednesday.from
object
obligatoire
Afficher les attributs enfants
results.weeklySchedule.wednesday.from.hour
integer
obligatoire
results.weeklySchedule.wednesday.from.minute
integer
results.weeklySchedule.wednesday.to
object
obligatoire
Afficher les attributs enfants
results.weeklySchedule.wednesday.to.hour
integer
obligatoire
results.weeklySchedule.wednesday.to.minute
integer
results.weeklySchedule.thursday
object
Afficher les attributs enfants
results.weeklySchedule.thursday.from
object
obligatoire
Afficher les attributs enfants
results.weeklySchedule.thursday.from.hour
integer
obligatoire
results.weeklySchedule.thursday.from.minute
integer
results.weeklySchedule.thursday.to
object
obligatoire
Afficher les attributs enfants
results.weeklySchedule.thursday.to.hour
integer
obligatoire
results.weeklySchedule.thursday.to.minute
integer
results.weeklySchedule.friday
object
Afficher les attributs enfants
results.weeklySchedule.friday.from
object
obligatoire
Afficher les attributs enfants
results.weeklySchedule.friday.from.hour
integer
obligatoire
results.weeklySchedule.friday.from.minute
integer
results.weeklySchedule.friday.to
object
obligatoire
Afficher les attributs enfants
results.weeklySchedule.friday.to.hour
integer
obligatoire
results.weeklySchedule.friday.to.minute
integer
results.weeklySchedule.saturday
object
Afficher les attributs enfants
results.weeklySchedule.saturday.from
object
obligatoire
Afficher les attributs enfants
results.weeklySchedule.saturday.from.hour
integer
obligatoire
results.weeklySchedule.saturday.from.minute
integer
results.weeklySchedule.saturday.to
object
obligatoire
Afficher les attributs enfants
results.weeklySchedule.saturday.to.hour
integer
obligatoire
results.weeklySchedule.saturday.to.minute
integer
results.weeklySchedule.sunday
object
Afficher les attributs enfants
results.weeklySchedule.sunday.from
object
obligatoire
Afficher les attributs enfants
results.weeklySchedule.sunday.from.hour
integer
obligatoire
results.weeklySchedule.sunday.from.minute
integer
results.weeklySchedule.sunday.to
object
obligatoire
Afficher les attributs enfants
results.weeklySchedule.sunday.to.hour
integer
obligatoire
results.weeklySchedule.sunday.to.minute
integer
results.holidays
array of object
obligatoire
Afficher les attributs enfants
results.holidays.name
string
obligatoire
results.holidays.day
integer
obligatoire
results.holidays.month
integer
obligatoire
results.assignedTeamIds
array of string
results.createdAt
string
obligatoire
results.updatedAt
string
obligatoire
results.currentStatus
string
Possible values: open, closed
results.nextOpenTime
string
The next time the business will be open. Null when business is currently open or permanently closed.
results.nextCloseTime
string
The next time the business will close. Null when business is currently closed or permanently closed.
Exemple de code
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/business-hours' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
POST
/workspaces/{workspaceId}/business-hours
Define and create new business hours, specifying the name, schedule.
Corps de la requête
name
string
obligatoire
description
string
timezone
string
obligatoire
weeklySchedule
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.monday
object
Afficher les paramètres enfants
weeklySchedule.monday.from
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.monday.from.hour
integer
obligatoire
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.monday.to.hour
integer
obligatoire
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Afficher les paramètres enfants
weeklySchedule.tuesday.from
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.tuesday.from.hour
integer
obligatoire
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.tuesday.to.hour
integer
obligatoire
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Afficher les paramètres enfants
weeklySchedule.wednesday.from
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.wednesday.from.hour
integer
obligatoire
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.wednesday.to.hour
integer
obligatoire
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Afficher les paramètres enfants
weeklySchedule.thursday.from
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.thursday.from.hour
integer
obligatoire
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.thursday.to.hour
integer
obligatoire
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Afficher les paramètres enfants
weeklySchedule.friday.from
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.friday.from.hour
integer
obligatoire
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.friday.to.hour
integer
obligatoire
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Afficher les paramètres enfants
weeklySchedule.saturday.from
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.saturday.from.hour
integer
obligatoire
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.saturday.to.hour
integer
obligatoire
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Afficher les paramètres enfants
weeklySchedule.sunday.from
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.sunday.from.hour
integer
obligatoire
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.sunday.to.hour
integer
obligatoire
weeklySchedule.sunday.to.minute
integer
holidays
array of object
obligatoire
Afficher les paramètres enfants
holidays.name
string
obligatoire
holidays.day
integer
obligatoire
holidays.month
integer
obligatoire
assignedTeamIds
array of string
Exemple de code
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/business-hours' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/business-hours/{businessHourId}
Retrieve information about specific business hours, including their name, schedule.
Corps de la réponse
id
string
obligatoire
name
string
obligatoire
description
string
timezone
string
obligatoire
weeklySchedule
object
obligatoire
Afficher les attributs enfants
weeklySchedule.monday
object
Afficher les attributs enfants
weeklySchedule.monday.from
object
obligatoire
Afficher les attributs enfants
weeklySchedule.monday.from.hour
integer
obligatoire
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
obligatoire
Afficher les attributs enfants
weeklySchedule.monday.to.hour
integer
obligatoire
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Afficher les attributs enfants
weeklySchedule.tuesday.from
object
obligatoire
Afficher les attributs enfants
weeklySchedule.tuesday.from.hour
integer
obligatoire
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
obligatoire
Afficher les attributs enfants
weeklySchedule.tuesday.to.hour
integer
obligatoire
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Afficher les attributs enfants
weeklySchedule.wednesday.from
object
obligatoire
Afficher les attributs enfants
weeklySchedule.wednesday.from.hour
integer
obligatoire
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
obligatoire
Afficher les attributs enfants
weeklySchedule.wednesday.to.hour
integer
obligatoire
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Afficher les attributs enfants
weeklySchedule.thursday.from
object
obligatoire
Afficher les attributs enfants
weeklySchedule.thursday.from.hour
integer
obligatoire
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
obligatoire
Afficher les attributs enfants
weeklySchedule.thursday.to.hour
integer
obligatoire
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Afficher les attributs enfants
weeklySchedule.friday.from
object
obligatoire
Afficher les attributs enfants
weeklySchedule.friday.from.hour
integer
obligatoire
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
obligatoire
Afficher les attributs enfants
weeklySchedule.friday.to.hour
integer
obligatoire
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Afficher les attributs enfants
weeklySchedule.saturday.from
object
obligatoire
Afficher les attributs enfants
weeklySchedule.saturday.from.hour
integer
obligatoire
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
obligatoire
Afficher les attributs enfants
weeklySchedule.saturday.to.hour
integer
obligatoire
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Afficher les attributs enfants
weeklySchedule.sunday.from
object
obligatoire
Afficher les attributs enfants
weeklySchedule.sunday.from.hour
integer
obligatoire
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
obligatoire
Afficher les attributs enfants
weeklySchedule.sunday.to.hour
integer
obligatoire
weeklySchedule.sunday.to.minute
integer
holidays
array of object
obligatoire
Afficher les attributs enfants
holidays.name
string
obligatoire
holidays.day
integer
obligatoire
holidays.month
integer
obligatoire
assignedTeamIds
array of string
createdAt
string
obligatoire
updatedAt
string
obligatoire
currentStatus
string
Possible values: open, closed
nextOpenTime
string
The next time the business will be open. Null when business is currently open or permanently closed.
nextCloseTime
string
The next time the business will close. Null when business is currently closed or permanently closed.
Exemple de code
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/business-hours/{businessHourId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/workspaces/{workspaceId}/business-hours/{businessHourId}
Modify the details of specific business hours, such as their name, schedule.
Corps de la requête
name
string
description
string
timezone
string
weeklySchedule
object
Afficher les paramètres enfants
weeklySchedule.monday
object
Afficher les paramètres enfants
weeklySchedule.monday.from
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.monday.from.hour
integer
obligatoire
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.monday.to.hour
integer
obligatoire
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Afficher les paramètres enfants
weeklySchedule.tuesday.from
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.tuesday.from.hour
integer
obligatoire
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.tuesday.to.hour
integer
obligatoire
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Afficher les paramètres enfants
weeklySchedule.wednesday.from
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.wednesday.from.hour
integer
obligatoire
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.wednesday.to.hour
integer
obligatoire
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Afficher les paramètres enfants
weeklySchedule.thursday.from
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.thursday.from.hour
integer
obligatoire
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.thursday.to.hour
integer
obligatoire
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Afficher les paramètres enfants
weeklySchedule.friday.from
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.friday.from.hour
integer
obligatoire
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.friday.to.hour
integer
obligatoire
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Afficher les paramètres enfants
weeklySchedule.saturday.from
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.saturday.from.hour
integer
obligatoire
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.saturday.to.hour
integer
obligatoire
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Afficher les paramètres enfants
weeklySchedule.sunday.from
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.sunday.from.hour
integer
obligatoire
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
obligatoire
Afficher les paramètres enfants
weeklySchedule.sunday.to.hour
integer
obligatoire
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Afficher les paramètres enfants
holidays.name
string
obligatoire
holidays.day
integer
obligatoire
holidays.month
integer
obligatoire
assignedTeamIds
array of string
Corps de la réponse
id
string
obligatoire
name
string
obligatoire
description
string
timezone
string
obligatoire
weeklySchedule
object
obligatoire
Afficher les attributs enfants
weeklySchedule.monday
object
Afficher les attributs enfants
weeklySchedule.monday.from
object
obligatoire
Afficher les attributs enfants
weeklySchedule.monday.from.hour
integer
obligatoire
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
obligatoire
Afficher les attributs enfants
weeklySchedule.monday.to.hour
integer
obligatoire
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Afficher les attributs enfants
weeklySchedule.tuesday.from
object
obligatoire
Afficher les attributs enfants
weeklySchedule.tuesday.from.hour
integer
obligatoire
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
obligatoire
Afficher les attributs enfants
weeklySchedule.tuesday.to.hour
integer
obligatoire
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Afficher les attributs enfants
weeklySchedule.wednesday.from
object
obligatoire
Afficher les attributs enfants
weeklySchedule.wednesday.from.hour
integer
obligatoire
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
obligatoire
Afficher les attributs enfants
weeklySchedule.wednesday.to.hour
integer
obligatoire
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Afficher les attributs enfants
weeklySchedule.thursday.from
object
obligatoire
Afficher les attributs enfants
weeklySchedule.thursday.from.hour
integer
obligatoire
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
obligatoire
Afficher les attributs enfants
weeklySchedule.thursday.to.hour
integer
obligatoire
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Afficher les attributs enfants
weeklySchedule.friday.from
object
obligatoire
Afficher les attributs enfants
weeklySchedule.friday.from.hour
integer
obligatoire
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
obligatoire
Afficher les attributs enfants
weeklySchedule.friday.to.hour
integer
obligatoire
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Afficher les attributs enfants
weeklySchedule.saturday.from
object
obligatoire
Afficher les attributs enfants
weeklySchedule.saturday.from.hour
integer
obligatoire
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
obligatoire
Afficher les attributs enfants
weeklySchedule.saturday.to.hour
integer
obligatoire
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Afficher les attributs enfants
weeklySchedule.sunday.from
object
obligatoire
Afficher les attributs enfants
weeklySchedule.sunday.from.hour
integer
obligatoire
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
obligatoire
Afficher les attributs enfants
weeklySchedule.sunday.to.hour
integer
obligatoire
weeklySchedule.sunday.to.minute
integer
holidays
array of object
obligatoire
Afficher les attributs enfants
holidays.name
string
obligatoire
holidays.day
integer
obligatoire
holidays.month
integer
obligatoire
assignedTeamIds
array of string
createdAt
string
obligatoire
updatedAt
string
obligatoire
currentStatus
string
Possible values: open, closed
nextOpenTime
string
The next time the business will be open. Null when business is currently open or permanently closed.
nextCloseTime
string
The next time the business will close. Null when business is currently closed or permanently closed.
Exemple de code
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/business-hours/{businessHourId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
DELETE
/workspaces/{workspaceId}/business-hours/{businessHourId}
Remove specific business hours, permanently deleting their defined schedule.
Exemple de code
curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/business-hours/{businessHourId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/business-hours/{businessHourId}/check
Determine if the current time falls within the defined business hours, providing information on availability.
Corps de la réponse
isOpen
boolean
obligatoire
Exemple de code
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/business-hours/{businessHourId}/check' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'