Skip to main content

Documentation Index

Fetch the complete documentation index at: https://koreai.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Back to Case Management API List Retrieves task data from the case management system with filters for status, priority, assignment, channels, and date ranges.
FieldValue
MethodPOST
Endpointhttps://{{host}}/caseManagement/api/public/analytics/{{streamId}}/getTasks
Content Typeapplication/json
Authorizationauth: {{JWT}} See How to generate the JWT Token.
API ScopeCase Management Configuration

​
Path Parameters

ParameterRequiredDescription
hostRequiredEnvironment URL. For example, https://platform.kore.ai.
streamIdRequiredBot identifier or Stream identifier. Access it from the General Settings page of the bot. For example, st-084d3c5e-376a-559f-9987-a012bb2bxxxx.

​
Header Parameters

ParameterRequiredDescription
accountIdRequiredThe account identifier associated with the API request. For example, 6639f7bd58c97ffac03bxxxx.

​
Sample Request

curl --location 'https://{{host}}/caseManagement/api/public/analytics/{{streamId}}/getTasks' \
--header 'AccountId: {{accountId}}' \
--header 'client-app: unified' \
--header 'X-Timezone-Offset: -330' \
--header 'auth: {{jwt-code}}' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data '{
    "skip": 0,
    "limit": 50,
    "searchText": "",
    "unresolved": false,
    "unassigned": true,
    "mytask": false,
    "selectedColumns": [],
    "priority": ["Critical"],
    "agents": [],
    "status": ["In-Progress"],
    "customFields": [],
    "ETAlist": [],
    "channel": ["rtm"],
    "queues": [],
    "startDate": "2025-05-26T18:30:00.000Z",
    "endDate": "2025-05-27T18:29:59.999Z",
    "sortBy": { "dueDate": "desc" }
}'

​
Request Body Parameters

ParameterRequiredTypeDescription
searchTextOptionalStringSearch text to filter tasks by name.
unresolvedOptionalBooleanRetrieves tasks that are still unresolved.
unassignedOptionalBooleanRetrieves tasks that are still unassigned.
mycaseOptionalBooleanRetrieves tasks assigned to the current user.
priorityOptionalArrayList of priorities to filter tasks. For example, high, medium.
statusOptionalArrayList of task statuses to filter by. For example, new, open.
channelOptionalArrayList of communication channels to filter by. For example, email, chat.
queuesOptionalArrayList of queues to filter cases by. For example, SupportQueue1.
startDateOptionalStringStart date of the task in ISO 8601 format.
endDateOptionalStringEnd date of the task in ISO 8601 format.
sortByOptionalStringField to sort by. For example, createdDate.
dueDateOptionalStringFilter by exact due date in ISO 8601 format.

​
Sample Response

{
  "results": [
    {
      "_id": "ti-c7c61c9-1392-45d3-b163-3622d737xxxx",
      "caseId": "ci-884ca36-6b0c-40bc-ba5c-bc8a8c6cxxxx",
      "caseRefId": "CS000108",
      "name": "This is demo task",
      "priority": { "name": "Medium", "color": "#16A34A" },
      "status": { "name": "Open", "statusCategory": "open" },
      "createdAt": "2025-05-28T12:05:38.807Z",
      "updatedAt": "2025-05-28T12:05:38.807Z"
    }
  ],
  "page": 1,
  "limit": 10,
  "hasMore": false,
  "totalPages": 1,
  "totalResults": 1
}