List closures
GET {{baseUrl}}/contact_center/closures?next_page_token=<string>&page_size=30&account_default=<boolean>
Get a list of closures. Admins can create closures to select.
Scopes: contact_center_queue:read:admin
contact_center_operating_hours:read:admin
Rate Limit Label: MEDIUM
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
next_page_token | string | Use the next page token paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. | |
page_size | number | The number of items returned per page. | |
account_default | string | Default business hours or closures for the newly-created queue. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_size":30,"total_records":"\u003cinteger\u003e","closure_sets":[{"account_default":"\u003cboolean\u003e","closure_set_id":"\u003cstring\u003e","closure_set_name":"\u003cstring\u003e","closures":[{"closure_hour_type":2,"closure_name":"\u003cstring\u003e","end_time":"\u003cstring\u003e","recurring_frequency":0,"start_time":"\u003cstring\u003e","closure_id":"\u003cstring\u003e","recurring_frequency_type":1,"recurring_month":2,"recurring_week_interval":"\u003cinteger\u003e","recurring_days_of_week":["\u003cstring\u003e","\u003cstring\u003e"]},{"closure_hour_type":2,"closure_name":"\u003cstring\u003e","end_time":"\u003cstring\u003e","recurring_frequency":3,"start_time":"\u003cstring\u003e","closure_id":"\u003cstring\u003e","recurring_frequency_type":1,"recurring_month":1,"recurring_week_interval":"\u003cinteger\u003e","recurring_days_of_week":["\u003cstring\u003e","\u003cstring\u003e"]}],"flows_count":"\u003cinteger\u003e","queues_count":"\u003cinteger\u003e","timezone":"\u003cstring\u003e"},{"account_default":"\u003cboolean\u003e","closure_set_id":"\u003cstring\u003e","closure_set_name":"\u003cstring\u003e","closures":[{"closure_hour_type":1,"closure_name":"\u003cstring\u003e","end_time":"\u003cstring\u003e","recurring_frequency":2,"start_time":"\u003cstring\u003e","closure_id":"\u003cstring\u003e","recurring_frequency_type":2,"recurring_month":3,"recurring_week_interval":"\u003cinteger\u003e","recurring_days_of_week":["\u003cstring\u003e","\u003cstring\u003e"]},{"closure_hour_type":2,"closure_name":"\u003cstring\u003e","end_time":"\u003cstring\u003e","recurring_frequency":1,"start_time":"\u003cstring\u003e","closure_id":"\u003cstring\u003e","recurring_frequency_type":1,"recurring_month":10,"recurring_week_interval":"\u003cinteger\u003e","recurring_days_of_week":["\u003cstring\u003e","\u003cstring\u003e"]}],"flows_count":"\u003cinteger\u003e","queues_count":"\u003cinteger\u003e","timezone":"\u003cstring\u003e"}]}