List cases

get

https://{hostname}/case-management/v3/cases

Lists open or closed cases. You can filter the results to fetch only your cases or cases created by all users of your account. You can also limit the request to a specific number of cases or time period.

📘
accountSwitchKey feature
This endpoint doesn't support the accountSwitchKey feature. Use the accountIds member instead.

Query Params

type

string

enum

required

Enum Type of cases to fetch. You can filter the results for your cases, MY_ACTIVE_CASES or MY_CLOSED_CASES, or for all users of your account, ALL_ACTIVE_CASES or ALL_CLOSED_CASES.

Allowed:

duration

integer

≥ 0

Number of days in the past to fetch cases for, based on the case's creation date. If omitted, the operation returns most recently created cases matching values of the type and limit parameters.

accountIds

string

List of accounts to fetch the cases for. To get these values, run the List available accounts operation. If omitted, Case Management fetches cases for all accounts you can access.

limit

integer

1 to 200

Defaults to 50

Data rows to fetch starting from the most recent. The maximum number of items is 200, 50 by default.

cursor

string

Cursor value for pagination. It occurs only if there's a next page of the results.

Response

Language

URL

Response

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

application/json

accountSwitchKey feature

200The response lists cases.