Getting a list of cases

get

https://api.talkdeskapp.com/cm/core/va/cases

Getting a list of cases.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

cases-public:read

Query Params

page

integer

1 to 2147483647

Defaults to 1

Page.

per_page

integer

1 to 500

Defaults to 50

Page size.

ids

array of strings

Comma-separated list of case ids to be queried.

ids

agent_id

string

length between 0 and 255

Agent id, the unique numeric identifiers given to each agent.

agent_name

string

length between 0 and 125

Agent name.

agent_email

string

length between 0 and 255

Agent email.

requester_type

string

enum

length between 0 and 255

The requester contains both the agent and contact. If this parameter passes in, it distinguishes; If doesn't pass in, it includes both.

Allowed:

requester_id

string

length between 0 and 255

The id of person who made the support request which can be a contact or an agent.

requester_name

string

length between 0 and 125

The name of person who made the support request which can be a contact or an agent.

requester_email

string

length between 0 and 255

The email of person who made the support request which can be a contact or an agent.

requester_phone

string

length between 0 and 20

The phone of person who made the support request which can be a contact or an agent.

title

string

length between 0 and 255

Case subject on the interface.

description

string

length between 0 and 1000000000

When a contact submits a support request via email, the body of the email request is used as the description. The description becomes the first comment in the case.

status

array of strings

Case status. For details, please see Overview.

status

Allowed:

priority

array of strings

Case priority. For details, please see Overview.

priority

Allowed:

type

array of strings

Case type. For details, please see Overview.

type

Allowed:

about

array of strings

Case about. For details, please see Overview.

about

create_at

array of date-times

Time when the case was created.

create_at

update_at

array of date-times

Time when the case was updated.

update_at

order_by

string

enum

length between 0 and 255

Which field to sort.

Allowed:

sort

string

enum

length between 0 and 255

Defaults to DESC

In what order to sort.

Allowed:

custom_fields

object

Fields which added by users.

Responses

Scope

200Success, return the list of cases.

400Bad Request.

401Unauthorized access - invalid or unverifiable JWT.

403Forbidden.

404Not Found.