| Field | Value |
|---|---|
| Method | POST |
| Endpoint | https://{{host}}/caseManagement/api/public/analytics/{{streamId}}/getTasks |
| Content Type | application/json |
| Authorization | auth: {{JWT}} See How to generate the JWT Token. |
| API Scope | Case Management Configuration |
Path Parameters
| Parameter | Required | Description |
|---|---|---|
host | Required | Environment URL. For example, https://platform.kore.ai. |
streamId | Required | Bot identifier or Stream identifier. Access it from the General Settings page of the bot. For example, st-084d3c5e-376a-559f-9987-a012bb2bxxxx. |
Header Parameters
| Parameter | Required | Description |
|---|---|---|
accountId | Required | The account identifier associated with the API request. For example, 6639f7bd58c97ffac03bxxxx. |
Sample Request
Request Body Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
searchText | Optional | String | Search text to filter tasks by name. |
unresolved | Optional | Boolean | Retrieves tasks that are still unresolved. |
unassigned | Optional | Boolean | Retrieves tasks that are still unassigned. |
mycase | Optional | Boolean | Retrieves tasks assigned to the current user. |
priority | Optional | Array | List of priorities to filter tasks. For example, high, medium. |
status | Optional | Array | List of task statuses to filter by. For example, new, open. |
channel | Optional | Array | List of communication channels to filter by. For example, email, chat. |
queues | Optional | Array | List of queues to filter cases by. For example, SupportQueue1. |
startDate | Optional | String | Start date of the task in ISO 8601 format. |
endDate | Optional | String | End date of the task in ISO 8601 format. |
sortBy | Optional | String | Field to sort by. For example, createdDate. |
dueDate | Optional | String | Filter by exact due date in ISO 8601 format. |