List tasks
GET {{baseUrl}}/contact_center/tasks?task_status=wrapping&queue_id=<string>&engagement_id=<string>&next_page_token=<string>
Use this API to return a list of tasks.
Scopes:
contact_center_task:read:admin
Rate Limit Label
:
Medium
Request Params
| Key | Datatype | Required | Description |
| task_status | string | | The task's status:
pendingreservedassignedcanceledcompletedwrapping| |queue_id| string | | The task's queue ID. | |engagement_id| string | | The task's engagement ID. | |next_page_token| string | | Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_size":30,"tasks":[{"task_id":"\u003cstring\u003e","workspace_id":"\u003cstring\u003e","task_timeout":"\u003cinteger\u003e","task_priority":"\u003cinteger\u003e","task_status":"reserved","channel_id":"\u003cstring\u003e","channel_name":"default","queue_id":"\u003cstring\u003e","queue_name":"\u003cstring\u003e","flow_id":"\u003cstring\u003e","flow_name":"\u003cstring\u003e","engagement_id":"\u003cstring\u003e","caller_number":"\u003cstring\u003e","callee_number":"\u003cstring\u003e","assigned_user_id":"\u003cstring\u003e","auto_assign":"\u003cboolean\u003e","created_time":"\u003cdateTime\u003e","last_modified_time":"\u003cdateTime\u003e"},{"task_id":"\u003cstring\u003e","workspace_id":"\u003cstring\u003e","task_timeout":"\u003cinteger\u003e","task_priority":"\u003cinteger\u003e","task_status":"canceled","channel_id":"\u003cstring\u003e","channel_name":"phone","queue_id":"\u003cstring\u003e","queue_name":"\u003cstring\u003e","flow_id":"\u003cstring\u003e","flow_name":"\u003cstring\u003e","engagement_id":"\u003cstring\u003e","caller_number":"\u003cstring\u003e","callee_number":"\u003cstring\u003e","assigned_user_id":"\u003cstring\u003e","auto_assign":"\u003cboolean\u003e","created_time":"\u003cdateTime\u003e","last_modified_time":"\u003cdateTime\u003e"}]}