List Cases

get

https://app.docsumo.com/api/v1/external/agents/{casetype_id}/cases

Retrieves a paginated list of cases for a specific case type, with support for filtering and sorting.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

casetype_id

string

required

The unique identifier of the case type. You can obtain this value from the List Agents endpoint.

Query Params

limit

integer

Defaults to 20

The number of cases to return per page. Accepts values between 0 and 100. Defaults to 20 if not specified.

offset

integer

Defaults to 0

The number of records to skip before starting to return results. Use this in combination with limit to paginate through the case list.

sort_by

string

enum

Defaults to created_date.desc

The field and direction to sort results by. Defaults to created_date.desc (newest cases first).

Allowed:

stage_id

array of strings

One or more stage IDs to filter cases by. Pass multiple values to filter by several stages

stage_id

assigned_to

array of strings

One or more user IDs to filter cases by assigned user. Pass multiple values to include cases assigned to any of the specified users.

assigned_to

workflow_state

array of strings

One or more workflow states to filter cases by. Pass multiple values to include cases in any of the specified states.

workflow_state

created_date_from

string

The start of the creation date range to filter by. Format: DD/MM/YYYY.

created_date_to

string

The end of the creation date range to filter by. Format: DD/MM/YYYY.

modified_date_from

string

The start of the last-modified date range to filter by. Format: DD/MM/YYYY.

modified_date_to

string

The end of the last-modified date range to filter by. Format: DD/MM/YYYY.

Headers

apikey

string

API key used for authentication. You can find your API key in your account settings.

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success.