List Tickets

get

https://api.edesk.com/v1/tickets

Return a list of tickets

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

order_by

string

enum

Order by field

Allowed:

order_direction

string

enum

Order direction

Allowed:

filter_contact_id_equals

int64

Filter by contact ID

filter_channel_id_equals

int64

Filter by channel ID

filter_channel_id_list

array of int64s

Tickets on any of these channels, comma separated, e.g. filter_channel_id_list=12,34 (or filter_channel_id_list[]=12&filter_channel_id_list[]=34).

filter_channel_id_list

filter_channel_id_excluding

array of int64s

Tickets on none of these channels, comma separated, e.g. filter_channel_id_excluding=12,34.

filter_channel_id_excluding

filter_brand_name_equals

string

Tickets on the channels of this brand. Brand names are matched ignoring case. A name that matches no brand returns no tickets.

filter_brand_name_list

array of strings

Tickets on the channels of any of these brands, comma separated, e.g. filter_brand_name_list=Brand A,Brand B. When a brand name contains a comma, repeat the parameter instead: filter_brand_name_list[]=Smith, Jones&filter_brand_name_list[]=Brand B. Names are matched ignoring case; when none of them matches a brand, no tickets are returned.

filter_brand_name_list

filter_brand_name_excluding

array of strings

Tickets on none of the channels of these brands, comma separated (repeat the parameter with [] when a brand name contains a comma). Names are matched ignoring case.

filter_brand_name_excluding

filter_status_equals

string

enum

Filter by status. The names used in the eDesk app are accepted too: ToDo is Pending, Waiting is Open, Resolved is Closed and Snoozed is Scheduled. Locked returns the locked tickets, when ticket locking is enabled for the account (otherwise there are none). Filtering by any other status leaves locked tickets out.

filter_type_equals

string

enum

Filter by type

filter_type_list

array of strings

Tickets of any of these types, comma separated, e.g. filter_type_list=OrderQuery,Refund. The values are those of filter_type_equals.

filter_type_list

filter_type_excluding

array of strings

Tickets of none of these types, comma separated, e.g. filter_type_excluding=SystemMessage,Chat. The values are those of filter_type_equals.

filter_type_excluding

filter_sales_order_id_equals

int64

Filter by sales order ID

filter_created_at_gte

string

Tickets created at or after this date or date-time, in ISO 8601: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS, optionally followed by Z or an offset such as +02:00. Without an offset the time is read in the timezone of the API user. A date alone means the start of that day. Without filter_created_at_lte, the results stop at the end of today.

filter_created_at_lte

string

Tickets created at or before this date or date-time, in the format of filter_created_at_gte. A date alone means the end of that day.

filter_last_updated_at_gte

string

Tickets last updated at or after this date or date-time, in the format of filter_created_at_gte. A date alone means the start of that day. Without filter_last_updated_at_lte, the results stop at the end of today.

filter_last_updated_at_lte

string

Tickets last updated at or before this date or date-time, in the format of filter_created_at_gte. A date alone means the end of that day.

filter_owner_user_id_equals

string

Filter by owner user ID, or unassigned for the tickets that have no owner, in any status (add filter_status_equals to narrow them down).

filter_owner_user_id_list

array of strings

Tickets owned by any of these users, comma separated. Add unassigned to include the tickets that have no owner, e.g. filter_owner_user_id_list=123,unassigned.

filter_owner_user_id_list

filter_owner_user_id_excluding

array of strings

Tickets owned by none of these users, comma separated. Tickets without an owner are kept unless unassigned is in the list, e.g. filter_owner_user_id_excluding=123,unassigned.

filter_owner_user_id_excluding

filter_seller_order_id_equals

string

Filter by seller order ID

filter_ticket_id_list

array of int64s

length ≤ 500

Up to 500 tickets by ID, comma separated, e.g. filter_ticket_id_list=1001,1002.

filter_ticket_id_list

filter_custom_field

object

Filter by ticket custom fields, one parameter per field: filter_custom_field[FIELD]=VALUE, where FIELD is the custom field ID (the id in a ticket's custom_fields) or its name. The value depends on the type of the field. Text: words the value contains. Number: a number, or a range MIN..MAX where either end may be left out (10.. or ..20). Yes/No: true or false. Select and multi select: one option, as returned in custom_fields (ignoring case); a multi select matches the tickets that have this option among their selections. Date: YYYY-MM-DD, or a range FROM..TO where either end may be left out. Date and time: a date or date-time in the format of filter_created_at_gte, or a range FROM..TO where either end may be left out; a date alone is the whole day. URL and email: the exact value, case-sensitive. Ranges include both ends. An unknown field or a value that does not fit the type of the field returns error code 4018.

include

array of strings

Optional fields to add to each ticket, comma separated, e.g. include=ai_classification,messages_ids_grouped (or include[]=ai_classification&include[]=messages_ids_grouped). The default fields are always returned. Optional fields of the nested sales order are named with a sales_order. prefix, e.g. include=sales_order.ship_to,sales_order.order_items.product.price.

include

Responses

200Get the list of tickets from all channels

400Validation error response

defaultDefault error response