DokumentasiEngagement 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.
Parameter query
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.
Payload respons
results
array of object
wajib
Tampilkan atribut turunan
results.id
string
wajib
results.name
string
wajib
results.description
string
results.timezone
string
wajib
results.weeklySchedule
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.monday
object
Tampilkan atribut turunan
results.weeklySchedule.monday.from
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.monday.from.hour
integer
wajib
results.weeklySchedule.monday.from.minute
integer
results.weeklySchedule.monday.to
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.monday.to.hour
integer
wajib
results.weeklySchedule.monday.to.minute
integer
results.weeklySchedule.tuesday
object
Tampilkan atribut turunan
results.weeklySchedule.tuesday.from
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.tuesday.from.hour
integer
wajib
results.weeklySchedule.tuesday.from.minute
integer
results.weeklySchedule.tuesday.to
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.tuesday.to.hour
integer
wajib
results.weeklySchedule.tuesday.to.minute
integer
results.weeklySchedule.wednesday
object
Tampilkan atribut turunan
results.weeklySchedule.wednesday.from
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.wednesday.from.hour
integer
wajib
results.weeklySchedule.wednesday.from.minute
integer
results.weeklySchedule.wednesday.to
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.wednesday.to.hour
integer
wajib
results.weeklySchedule.wednesday.to.minute
integer
results.weeklySchedule.thursday
object
Tampilkan atribut turunan
results.weeklySchedule.thursday.from
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.thursday.from.hour
integer
wajib
results.weeklySchedule.thursday.from.minute
integer
results.weeklySchedule.thursday.to
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.thursday.to.hour
integer
wajib
results.weeklySchedule.thursday.to.minute
integer
results.weeklySchedule.friday
object
Tampilkan atribut turunan
results.weeklySchedule.friday.from
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.friday.from.hour
integer
wajib
results.weeklySchedule.friday.from.minute
integer
results.weeklySchedule.friday.to
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.friday.to.hour
integer
wajib
results.weeklySchedule.friday.to.minute
integer
results.weeklySchedule.saturday
object
Tampilkan atribut turunan
results.weeklySchedule.saturday.from
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.saturday.from.hour
integer
wajib
results.weeklySchedule.saturday.from.minute
integer
results.weeklySchedule.saturday.to
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.saturday.to.hour
integer
wajib
results.weeklySchedule.saturday.to.minute
integer
results.weeklySchedule.sunday
object
Tampilkan atribut turunan
results.weeklySchedule.sunday.from
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.sunday.from.hour
integer
wajib
results.weeklySchedule.sunday.from.minute
integer
results.weeklySchedule.sunday.to
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.sunday.to.hour
integer
wajib
results.weeklySchedule.sunday.to.minute
integer
results.holidays
array of object
wajib
Tampilkan atribut turunan
results.holidays.name
string
wajib
results.holidays.day
integer
wajib
results.holidays.month
integer
wajib
results.assignedTeamIds
array of string
results.createdAt
string
wajib
results.updatedAt
string
wajib
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.
Contoh kode
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.
Payload permintaan
name
string
wajib
description
string
timezone
string
wajib
weeklySchedule
object
wajib
Tampilkan parameter turunan
weeklySchedule.monday
object
Tampilkan parameter turunan
weeklySchedule.monday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.monday.from.hour
integer
wajib
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.monday.to.hour
integer
wajib
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Tampilkan parameter turunan
weeklySchedule.tuesday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.tuesday.from.hour
integer
wajib
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.tuesday.to.hour
integer
wajib
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Tampilkan parameter turunan
weeklySchedule.wednesday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.wednesday.from.hour
integer
wajib
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.wednesday.to.hour
integer
wajib
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Tampilkan parameter turunan
weeklySchedule.thursday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.thursday.from.hour
integer
wajib
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.thursday.to.hour
integer
wajib
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Tampilkan parameter turunan
weeklySchedule.friday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.friday.from.hour
integer
wajib
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.friday.to.hour
integer
wajib
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Tampilkan parameter turunan
weeklySchedule.saturday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.saturday.from.hour
integer
wajib
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.saturday.to.hour
integer
wajib
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Tampilkan parameter turunan
weeklySchedule.sunday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.sunday.from.hour
integer
wajib
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.sunday.to.hour
integer
wajib
weeklySchedule.sunday.to.minute
integer
holidays
array of object
wajib
Tampilkan parameter turunan
holidays.name
string
wajib
holidays.day
integer
wajib
holidays.month
integer
wajib
assignedTeamIds
array of string
Contoh kode
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.
Payload respons
id
string
wajib
name
string
wajib
description
string
timezone
string
wajib
weeklySchedule
object
wajib
Tampilkan atribut turunan
weeklySchedule.monday
object
Tampilkan atribut turunan
weeklySchedule.monday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.monday.from.hour
integer
wajib
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.monday.to.hour
integer
wajib
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Tampilkan atribut turunan
weeklySchedule.tuesday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.tuesday.from.hour
integer
wajib
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.tuesday.to.hour
integer
wajib
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Tampilkan atribut turunan
weeklySchedule.wednesday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.wednesday.from.hour
integer
wajib
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.wednesday.to.hour
integer
wajib
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Tampilkan atribut turunan
weeklySchedule.thursday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.thursday.from.hour
integer
wajib
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.thursday.to.hour
integer
wajib
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Tampilkan atribut turunan
weeklySchedule.friday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.friday.from.hour
integer
wajib
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.friday.to.hour
integer
wajib
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Tampilkan atribut turunan
weeklySchedule.saturday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.saturday.from.hour
integer
wajib
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.saturday.to.hour
integer
wajib
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Tampilkan atribut turunan
weeklySchedule.sunday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.sunday.from.hour
integer
wajib
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.sunday.to.hour
integer
wajib
weeklySchedule.sunday.to.minute
integer
holidays
array of object
wajib
Tampilkan atribut turunan
holidays.name
string
wajib
holidays.day
integer
wajib
holidays.month
integer
wajib
assignedTeamIds
array of string
createdAt
string
wajib
updatedAt
string
wajib
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.
Contoh kode
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.
Payload permintaan
name
string
description
string
timezone
string
weeklySchedule
object
Tampilkan parameter turunan
weeklySchedule.monday
object
Tampilkan parameter turunan
weeklySchedule.monday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.monday.from.hour
integer
wajib
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.monday.to.hour
integer
wajib
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Tampilkan parameter turunan
weeklySchedule.tuesday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.tuesday.from.hour
integer
wajib
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.tuesday.to.hour
integer
wajib
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Tampilkan parameter turunan
weeklySchedule.wednesday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.wednesday.from.hour
integer
wajib
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.wednesday.to.hour
integer
wajib
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Tampilkan parameter turunan
weeklySchedule.thursday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.thursday.from.hour
integer
wajib
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.thursday.to.hour
integer
wajib
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Tampilkan parameter turunan
weeklySchedule.friday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.friday.from.hour
integer
wajib
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.friday.to.hour
integer
wajib
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Tampilkan parameter turunan
weeklySchedule.saturday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.saturday.from.hour
integer
wajib
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.saturday.to.hour
integer
wajib
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Tampilkan parameter turunan
weeklySchedule.sunday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.sunday.from.hour
integer
wajib
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.sunday.to.hour
integer
wajib
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Tampilkan parameter turunan
holidays.name
string
wajib
holidays.day
integer
wajib
holidays.month
integer
wajib
assignedTeamIds
array of string
Payload respons
id
string
wajib
name
string
wajib
description
string
timezone
string
wajib
weeklySchedule
object
wajib
Tampilkan atribut turunan
weeklySchedule.monday
object
Tampilkan atribut turunan
weeklySchedule.monday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.monday.from.hour
integer
wajib
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.monday.to.hour
integer
wajib
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Tampilkan atribut turunan
weeklySchedule.tuesday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.tuesday.from.hour
integer
wajib
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.tuesday.to.hour
integer
wajib
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Tampilkan atribut turunan
weeklySchedule.wednesday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.wednesday.from.hour
integer
wajib
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.wednesday.to.hour
integer
wajib
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Tampilkan atribut turunan
weeklySchedule.thursday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.thursday.from.hour
integer
wajib
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.thursday.to.hour
integer
wajib
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Tampilkan atribut turunan
weeklySchedule.friday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.friday.from.hour
integer
wajib
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.friday.to.hour
integer
wajib
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Tampilkan atribut turunan
weeklySchedule.saturday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.saturday.from.hour
integer
wajib
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.saturday.to.hour
integer
wajib
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Tampilkan atribut turunan
weeklySchedule.sunday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.sunday.from.hour
integer
wajib
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.sunday.to.hour
integer
wajib
weeklySchedule.sunday.to.minute
integer
holidays
array of object
wajib
Tampilkan atribut turunan
holidays.name
string
wajib
holidays.day
integer
wajib
holidays.month
integer
wajib
assignedTeamIds
array of string
createdAt
string
wajib
updatedAt
string
wajib
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.
Contoh kode
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.
Contoh kode
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.
Payload respons
isOpen
boolean
wajib
Contoh kode
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/business-hours/{businessHourId}/check' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'