DokumentacjaEngagement 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.
Parametry zapytania
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.
Treść odpowiedzi
results
array of object
wymagane
Pokaż atrybuty podrzędne
results.id
string
wymagane
results.name
string
wymagane
results.description
string
results.timezone
string
wymagane
results.weeklySchedule
object
wymagane
Pokaż atrybuty podrzędne
results.weeklySchedule.monday
object
Pokaż atrybuty podrzędne
results.weeklySchedule.monday.from
object
wymagane
Pokaż atrybuty podrzędne
results.weeklySchedule.monday.from.hour
integer
wymagane
results.weeklySchedule.monday.from.minute
integer
results.weeklySchedule.monday.to
object
wymagane
Pokaż atrybuty podrzędne
results.weeklySchedule.monday.to.hour
integer
wymagane
results.weeklySchedule.monday.to.minute
integer
results.weeklySchedule.tuesday
object
Pokaż atrybuty podrzędne
results.weeklySchedule.tuesday.from
object
wymagane
Pokaż atrybuty podrzędne
results.weeklySchedule.tuesday.from.hour
integer
wymagane
results.weeklySchedule.tuesday.from.minute
integer
results.weeklySchedule.tuesday.to
object
wymagane
Pokaż atrybuty podrzędne
results.weeklySchedule.tuesday.to.hour
integer
wymagane
results.weeklySchedule.tuesday.to.minute
integer
results.weeklySchedule.wednesday
object
Pokaż atrybuty podrzędne
results.weeklySchedule.wednesday.from
object
wymagane
Pokaż atrybuty podrzędne
results.weeklySchedule.wednesday.from.hour
integer
wymagane
results.weeklySchedule.wednesday.from.minute
integer
results.weeklySchedule.wednesday.to
object
wymagane
Pokaż atrybuty podrzędne
results.weeklySchedule.wednesday.to.hour
integer
wymagane
results.weeklySchedule.wednesday.to.minute
integer
results.weeklySchedule.thursday
object
Pokaż atrybuty podrzędne
results.weeklySchedule.thursday.from
object
wymagane
Pokaż atrybuty podrzędne
results.weeklySchedule.thursday.from.hour
integer
wymagane
results.weeklySchedule.thursday.from.minute
integer
results.weeklySchedule.thursday.to
object
wymagane
Pokaż atrybuty podrzędne
results.weeklySchedule.thursday.to.hour
integer
wymagane
results.weeklySchedule.thursday.to.minute
integer
results.weeklySchedule.friday
object
Pokaż atrybuty podrzędne
results.weeklySchedule.friday.from
object
wymagane
Pokaż atrybuty podrzędne
results.weeklySchedule.friday.from.hour
integer
wymagane
results.weeklySchedule.friday.from.minute
integer
results.weeklySchedule.friday.to
object
wymagane
Pokaż atrybuty podrzędne
results.weeklySchedule.friday.to.hour
integer
wymagane
results.weeklySchedule.friday.to.minute
integer
results.weeklySchedule.saturday
object
Pokaż atrybuty podrzędne
results.weeklySchedule.saturday.from
object
wymagane
Pokaż atrybuty podrzędne
results.weeklySchedule.saturday.from.hour
integer
wymagane
results.weeklySchedule.saturday.from.minute
integer
results.weeklySchedule.saturday.to
object
wymagane
Pokaż atrybuty podrzędne
results.weeklySchedule.saturday.to.hour
integer
wymagane
results.weeklySchedule.saturday.to.minute
integer
results.weeklySchedule.sunday
object
Pokaż atrybuty podrzędne
results.weeklySchedule.sunday.from
object
wymagane
Pokaż atrybuty podrzędne
results.weeklySchedule.sunday.from.hour
integer
wymagane
results.weeklySchedule.sunday.from.minute
integer
results.weeklySchedule.sunday.to
object
wymagane
Pokaż atrybuty podrzędne
results.weeklySchedule.sunday.to.hour
integer
wymagane
results.weeklySchedule.sunday.to.minute
integer
results.holidays
array of object
wymagane
Pokaż atrybuty podrzędne
results.holidays.name
string
wymagane
results.holidays.day
integer
wymagane
results.holidays.month
integer
wymagane
results.assignedTeamIds
array of string
results.createdAt
string
wymagane
results.updatedAt
string
wymagane
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.
Przykład kodu
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.
Treść żądania
name
string
wymagane
description
string
timezone
string
wymagane
weeklySchedule
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.monday
object
Pokaż parametry podrzędne
weeklySchedule.monday.from
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.monday.from.hour
integer
wymagane
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.monday.to.hour
integer
wymagane
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Pokaż parametry podrzędne
weeklySchedule.tuesday.from
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.tuesday.from.hour
integer
wymagane
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.tuesday.to.hour
integer
wymagane
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Pokaż parametry podrzędne
weeklySchedule.wednesday.from
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.wednesday.from.hour
integer
wymagane
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.wednesday.to.hour
integer
wymagane
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Pokaż parametry podrzędne
weeklySchedule.thursday.from
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.thursday.from.hour
integer
wymagane
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.thursday.to.hour
integer
wymagane
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Pokaż parametry podrzędne
weeklySchedule.friday.from
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.friday.from.hour
integer
wymagane
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.friday.to.hour
integer
wymagane
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Pokaż parametry podrzędne
weeklySchedule.saturday.from
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.saturday.from.hour
integer
wymagane
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.saturday.to.hour
integer
wymagane
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Pokaż parametry podrzędne
weeklySchedule.sunday.from
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.sunday.from.hour
integer
wymagane
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.sunday.to.hour
integer
wymagane
weeklySchedule.sunday.to.minute
integer
holidays
array of object
wymagane
Pokaż parametry podrzędne
holidays.name
string
wymagane
holidays.day
integer
wymagane
holidays.month
integer
wymagane
assignedTeamIds
array of string
Przykład kodu
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.
Treść odpowiedzi
id
string
wymagane
name
string
wymagane
description
string
timezone
string
wymagane
weeklySchedule
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.monday
object
Pokaż atrybuty podrzędne
weeklySchedule.monday.from
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.monday.from.hour
integer
wymagane
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.monday.to.hour
integer
wymagane
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Pokaż atrybuty podrzędne
weeklySchedule.tuesday.from
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.tuesday.from.hour
integer
wymagane
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.tuesday.to.hour
integer
wymagane
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Pokaż atrybuty podrzędne
weeklySchedule.wednesday.from
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.wednesday.from.hour
integer
wymagane
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.wednesday.to.hour
integer
wymagane
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Pokaż atrybuty podrzędne
weeklySchedule.thursday.from
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.thursday.from.hour
integer
wymagane
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.thursday.to.hour
integer
wymagane
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Pokaż atrybuty podrzędne
weeklySchedule.friday.from
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.friday.from.hour
integer
wymagane
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.friday.to.hour
integer
wymagane
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Pokaż atrybuty podrzędne
weeklySchedule.saturday.from
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.saturday.from.hour
integer
wymagane
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.saturday.to.hour
integer
wymagane
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Pokaż atrybuty podrzędne
weeklySchedule.sunday.from
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.sunday.from.hour
integer
wymagane
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.sunday.to.hour
integer
wymagane
weeklySchedule.sunday.to.minute
integer
holidays
array of object
wymagane
Pokaż atrybuty podrzędne
holidays.name
string
wymagane
holidays.day
integer
wymagane
holidays.month
integer
wymagane
assignedTeamIds
array of string
createdAt
string
wymagane
updatedAt
string
wymagane
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.
Przykład kodu
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.
Treść żądania
name
string
description
string
timezone
string
weeklySchedule
object
Pokaż parametry podrzędne
weeklySchedule.monday
object
Pokaż parametry podrzędne
weeklySchedule.monday.from
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.monday.from.hour
integer
wymagane
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.monday.to.hour
integer
wymagane
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Pokaż parametry podrzędne
weeklySchedule.tuesday.from
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.tuesday.from.hour
integer
wymagane
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.tuesday.to.hour
integer
wymagane
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Pokaż parametry podrzędne
weeklySchedule.wednesday.from
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.wednesday.from.hour
integer
wymagane
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.wednesday.to.hour
integer
wymagane
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Pokaż parametry podrzędne
weeklySchedule.thursday.from
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.thursday.from.hour
integer
wymagane
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.thursday.to.hour
integer
wymagane
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Pokaż parametry podrzędne
weeklySchedule.friday.from
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.friday.from.hour
integer
wymagane
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.friday.to.hour
integer
wymagane
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Pokaż parametry podrzędne
weeklySchedule.saturday.from
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.saturday.from.hour
integer
wymagane
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.saturday.to.hour
integer
wymagane
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Pokaż parametry podrzędne
weeklySchedule.sunday.from
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.sunday.from.hour
integer
wymagane
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
wymagane
Pokaż parametry podrzędne
weeklySchedule.sunday.to.hour
integer
wymagane
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Pokaż parametry podrzędne
holidays.name
string
wymagane
holidays.day
integer
wymagane
holidays.month
integer
wymagane
assignedTeamIds
array of string
Treść odpowiedzi
id
string
wymagane
name
string
wymagane
description
string
timezone
string
wymagane
weeklySchedule
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.monday
object
Pokaż atrybuty podrzędne
weeklySchedule.monday.from
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.monday.from.hour
integer
wymagane
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.monday.to.hour
integer
wymagane
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Pokaż atrybuty podrzędne
weeklySchedule.tuesday.from
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.tuesday.from.hour
integer
wymagane
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.tuesday.to.hour
integer
wymagane
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Pokaż atrybuty podrzędne
weeklySchedule.wednesday.from
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.wednesday.from.hour
integer
wymagane
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.wednesday.to.hour
integer
wymagane
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Pokaż atrybuty podrzędne
weeklySchedule.thursday.from
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.thursday.from.hour
integer
wymagane
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.thursday.to.hour
integer
wymagane
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Pokaż atrybuty podrzędne
weeklySchedule.friday.from
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.friday.from.hour
integer
wymagane
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.friday.to.hour
integer
wymagane
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Pokaż atrybuty podrzędne
weeklySchedule.saturday.from
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.saturday.from.hour
integer
wymagane
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.saturday.to.hour
integer
wymagane
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Pokaż atrybuty podrzędne
weeklySchedule.sunday.from
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.sunday.from.hour
integer
wymagane
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
wymagane
Pokaż atrybuty podrzędne
weeklySchedule.sunday.to.hour
integer
wymagane
weeklySchedule.sunday.to.minute
integer
holidays
array of object
wymagane
Pokaż atrybuty podrzędne
holidays.name
string
wymagane
holidays.day
integer
wymagane
holidays.month
integer
wymagane
assignedTeamIds
array of string
createdAt
string
wymagane
updatedAt
string
wymagane
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.
Przykład kodu
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.
Przykład kodu
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.
Treść odpowiedzi
isOpen
boolean
wymagane
Przykład kodu
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/business-hours/{businessHourId}/check' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'