DokumentationEngagement 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.
Abfrageparameter
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.
Antwort-Payload
results
array of object
erforderlich
Untergeordnete Attribute anzeigen
results.id
string
erforderlich
results.name
string
erforderlich
results.description
string
results.timezone
string
erforderlich
results.weeklySchedule
object
erforderlich
Untergeordnete Attribute anzeigen
results.weeklySchedule.monday
object
Untergeordnete Attribute anzeigen
results.weeklySchedule.monday.from
object
erforderlich
Untergeordnete Attribute anzeigen
results.weeklySchedule.monday.from.hour
integer
erforderlich
results.weeklySchedule.monday.from.minute
integer
results.weeklySchedule.monday.to
object
erforderlich
Untergeordnete Attribute anzeigen
results.weeklySchedule.monday.to.hour
integer
erforderlich
results.weeklySchedule.monday.to.minute
integer
results.weeklySchedule.tuesday
object
Untergeordnete Attribute anzeigen
results.weeklySchedule.tuesday.from
object
erforderlich
Untergeordnete Attribute anzeigen
results.weeklySchedule.tuesday.from.hour
integer
erforderlich
results.weeklySchedule.tuesday.from.minute
integer
results.weeklySchedule.tuesday.to
object
erforderlich
Untergeordnete Attribute anzeigen
results.weeklySchedule.tuesday.to.hour
integer
erforderlich
results.weeklySchedule.tuesday.to.minute
integer
results.weeklySchedule.wednesday
object
Untergeordnete Attribute anzeigen
results.weeklySchedule.wednesday.from
object
erforderlich
Untergeordnete Attribute anzeigen
results.weeklySchedule.wednesday.from.hour
integer
erforderlich
results.weeklySchedule.wednesday.from.minute
integer
results.weeklySchedule.wednesday.to
object
erforderlich
Untergeordnete Attribute anzeigen
results.weeklySchedule.wednesday.to.hour
integer
erforderlich
results.weeklySchedule.wednesday.to.minute
integer
results.weeklySchedule.thursday
object
Untergeordnete Attribute anzeigen
results.weeklySchedule.thursday.from
object
erforderlich
Untergeordnete Attribute anzeigen
results.weeklySchedule.thursday.from.hour
integer
erforderlich
results.weeklySchedule.thursday.from.minute
integer
results.weeklySchedule.thursday.to
object
erforderlich
Untergeordnete Attribute anzeigen
results.weeklySchedule.thursday.to.hour
integer
erforderlich
results.weeklySchedule.thursday.to.minute
integer
results.weeklySchedule.friday
object
Untergeordnete Attribute anzeigen
results.weeklySchedule.friday.from
object
erforderlich
Untergeordnete Attribute anzeigen
results.weeklySchedule.friday.from.hour
integer
erforderlich
results.weeklySchedule.friday.from.minute
integer
results.weeklySchedule.friday.to
object
erforderlich
Untergeordnete Attribute anzeigen
results.weeklySchedule.friday.to.hour
integer
erforderlich
results.weeklySchedule.friday.to.minute
integer
results.weeklySchedule.saturday
object
Untergeordnete Attribute anzeigen
results.weeklySchedule.saturday.from
object
erforderlich
Untergeordnete Attribute anzeigen
results.weeklySchedule.saturday.from.hour
integer
erforderlich
results.weeklySchedule.saturday.from.minute
integer
results.weeklySchedule.saturday.to
object
erforderlich
Untergeordnete Attribute anzeigen
results.weeklySchedule.saturday.to.hour
integer
erforderlich
results.weeklySchedule.saturday.to.minute
integer
results.weeklySchedule.sunday
object
Untergeordnete Attribute anzeigen
results.weeklySchedule.sunday.from
object
erforderlich
Untergeordnete Attribute anzeigen
results.weeklySchedule.sunday.from.hour
integer
erforderlich
results.weeklySchedule.sunday.from.minute
integer
results.weeklySchedule.sunday.to
object
erforderlich
Untergeordnete Attribute anzeigen
results.weeklySchedule.sunday.to.hour
integer
erforderlich
results.weeklySchedule.sunday.to.minute
integer
results.holidays
array of object
erforderlich
Untergeordnete Attribute anzeigen
results.holidays.name
string
erforderlich
results.holidays.day
integer
erforderlich
results.holidays.month
integer
erforderlich
results.assignedTeamIds
array of string
results.createdAt
string
erforderlich
results.updatedAt
string
erforderlich
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.
Codebeispiel
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.
Anfrage-Payload
name
string
erforderlich
description
string
timezone
string
erforderlich
weeklySchedule
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.monday
object
Untergeordnete Parameter anzeigen
weeklySchedule.monday.from
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.monday.from.hour
integer
erforderlich
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.monday.to.hour
integer
erforderlich
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Untergeordnete Parameter anzeigen
weeklySchedule.tuesday.from
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.tuesday.from.hour
integer
erforderlich
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.tuesday.to.hour
integer
erforderlich
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Untergeordnete Parameter anzeigen
weeklySchedule.wednesday.from
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.wednesday.from.hour
integer
erforderlich
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.wednesday.to.hour
integer
erforderlich
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Untergeordnete Parameter anzeigen
weeklySchedule.thursday.from
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.thursday.from.hour
integer
erforderlich
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.thursday.to.hour
integer
erforderlich
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Untergeordnete Parameter anzeigen
weeklySchedule.friday.from
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.friday.from.hour
integer
erforderlich
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.friday.to.hour
integer
erforderlich
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Untergeordnete Parameter anzeigen
weeklySchedule.saturday.from
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.saturday.from.hour
integer
erforderlich
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.saturday.to.hour
integer
erforderlich
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Untergeordnete Parameter anzeigen
weeklySchedule.sunday.from
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.sunday.from.hour
integer
erforderlich
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.sunday.to.hour
integer
erforderlich
weeklySchedule.sunday.to.minute
integer
holidays
array of object
erforderlich
Untergeordnete Parameter anzeigen
holidays.name
string
erforderlich
holidays.day
integer
erforderlich
holidays.month
integer
erforderlich
assignedTeamIds
array of string
Codebeispiel
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.
Antwort-Payload
id
string
erforderlich
name
string
erforderlich
description
string
timezone
string
erforderlich
weeklySchedule
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.monday
object
Untergeordnete Attribute anzeigen
weeklySchedule.monday.from
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.monday.from.hour
integer
erforderlich
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.monday.to.hour
integer
erforderlich
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Untergeordnete Attribute anzeigen
weeklySchedule.tuesday.from
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.tuesday.from.hour
integer
erforderlich
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.tuesday.to.hour
integer
erforderlich
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Untergeordnete Attribute anzeigen
weeklySchedule.wednesday.from
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.wednesday.from.hour
integer
erforderlich
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.wednesday.to.hour
integer
erforderlich
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Untergeordnete Attribute anzeigen
weeklySchedule.thursday.from
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.thursday.from.hour
integer
erforderlich
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.thursday.to.hour
integer
erforderlich
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Untergeordnete Attribute anzeigen
weeklySchedule.friday.from
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.friday.from.hour
integer
erforderlich
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.friday.to.hour
integer
erforderlich
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Untergeordnete Attribute anzeigen
weeklySchedule.saturday.from
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.saturday.from.hour
integer
erforderlich
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.saturday.to.hour
integer
erforderlich
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Untergeordnete Attribute anzeigen
weeklySchedule.sunday.from
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.sunday.from.hour
integer
erforderlich
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.sunday.to.hour
integer
erforderlich
weeklySchedule.sunday.to.minute
integer
holidays
array of object
erforderlich
Untergeordnete Attribute anzeigen
holidays.name
string
erforderlich
holidays.day
integer
erforderlich
holidays.month
integer
erforderlich
assignedTeamIds
array of string
createdAt
string
erforderlich
updatedAt
string
erforderlich
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.
Codebeispiel
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.
Anfrage-Payload
name
string
description
string
timezone
string
weeklySchedule
object
Untergeordnete Parameter anzeigen
weeklySchedule.monday
object
Untergeordnete Parameter anzeigen
weeklySchedule.monday.from
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.monday.from.hour
integer
erforderlich
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.monday.to.hour
integer
erforderlich
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Untergeordnete Parameter anzeigen
weeklySchedule.tuesday.from
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.tuesday.from.hour
integer
erforderlich
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.tuesday.to.hour
integer
erforderlich
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Untergeordnete Parameter anzeigen
weeklySchedule.wednesday.from
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.wednesday.from.hour
integer
erforderlich
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.wednesday.to.hour
integer
erforderlich
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Untergeordnete Parameter anzeigen
weeklySchedule.thursday.from
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.thursday.from.hour
integer
erforderlich
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.thursday.to.hour
integer
erforderlich
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Untergeordnete Parameter anzeigen
weeklySchedule.friday.from
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.friday.from.hour
integer
erforderlich
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.friday.to.hour
integer
erforderlich
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Untergeordnete Parameter anzeigen
weeklySchedule.saturday.from
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.saturday.from.hour
integer
erforderlich
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.saturday.to.hour
integer
erforderlich
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Untergeordnete Parameter anzeigen
weeklySchedule.sunday.from
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.sunday.from.hour
integer
erforderlich
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
erforderlich
Untergeordnete Parameter anzeigen
weeklySchedule.sunday.to.hour
integer
erforderlich
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Untergeordnete Parameter anzeigen
holidays.name
string
erforderlich
holidays.day
integer
erforderlich
holidays.month
integer
erforderlich
assignedTeamIds
array of string
Antwort-Payload
id
string
erforderlich
name
string
erforderlich
description
string
timezone
string
erforderlich
weeklySchedule
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.monday
object
Untergeordnete Attribute anzeigen
weeklySchedule.monday.from
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.monday.from.hour
integer
erforderlich
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.monday.to.hour
integer
erforderlich
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Untergeordnete Attribute anzeigen
weeklySchedule.tuesday.from
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.tuesday.from.hour
integer
erforderlich
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.tuesday.to.hour
integer
erforderlich
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Untergeordnete Attribute anzeigen
weeklySchedule.wednesday.from
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.wednesday.from.hour
integer
erforderlich
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.wednesday.to.hour
integer
erforderlich
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Untergeordnete Attribute anzeigen
weeklySchedule.thursday.from
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.thursday.from.hour
integer
erforderlich
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.thursday.to.hour
integer
erforderlich
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Untergeordnete Attribute anzeigen
weeklySchedule.friday.from
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.friday.from.hour
integer
erforderlich
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.friday.to.hour
integer
erforderlich
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Untergeordnete Attribute anzeigen
weeklySchedule.saturday.from
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.saturday.from.hour
integer
erforderlich
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.saturday.to.hour
integer
erforderlich
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Untergeordnete Attribute anzeigen
weeklySchedule.sunday.from
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.sunday.from.hour
integer
erforderlich
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
erforderlich
Untergeordnete Attribute anzeigen
weeklySchedule.sunday.to.hour
integer
erforderlich
weeklySchedule.sunday.to.minute
integer
holidays
array of object
erforderlich
Untergeordnete Attribute anzeigen
holidays.name
string
erforderlich
holidays.day
integer
erforderlich
holidays.month
integer
erforderlich
assignedTeamIds
array of string
createdAt
string
erforderlich
updatedAt
string
erforderlich
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.
Codebeispiel
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.
Codebeispiel
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.
Antwort-Payload
isOpen
boolean
erforderlich
Codebeispiel
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/business-hours/{businessHourId}/check' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'