Skip to main content
GET
List all tickets
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
default:your-api-key
required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Query Parameters

page_number
integer

Page of results to retrieve, starting from 1. Defaults to 1 when omitted.

page_size
integer

Number of results per page. Defaults to 30 when omitted.

status
string

Filter tickets by their status. Accepts comma-separated values for multiple statuses. Default statuses include: new, open, waiting_on_customer, on_hold, closed, spam, trash. Custom statuses created in your organization are also supported. open matches both new and open tickets. If omitted, tickets of all statuses are returned.

Example:

"open"

priority
string

Filter tickets by priority. Accepts comma-separated values, such as high,urgent.

Example:

"high,urgent"

unassigned
boolean

Pass true to return only tickets that have no assignee. It cannot be combined with assignee_id or assignee_email.

Example:

true

customer_domain
string

Return only tickets whose customer has an email address at this domain. A leading @ is ignored.

Example:

"acme.com"

tags
string

Return tickets carrying any of these tags. Accepts comma-separated tag names, matched without regard to case.

Example:

"billing,vip"

query
string

Return tickets whose subject contains this text, matched without regard to case.

Example:

"refund"

external_id
string

Return only the ticket carrying this external_id. Used by an importer to check whether a source record has already been created before posting it again.

Example:

"CP-1234"

customer_id
string

Return only tickets belonging to the customer with this customer_id.

Example:

"aaaabbbb-cccc-dddd-eeee-ffff00002222"

customer_email
string

Return only tickets belonging to the customer with this email address.

Example:

"oliver@example.com"

assignee_id
string

Return only tickets assigned to the team member with this assignee_id.

Example:

"aaaabbbb-cccc-dddd-eeee-ffff00001111"

assignee_email
string

Return only tickets assigned to the team member with this email address.

Example:

"ethan@example.com"

field_name
string

Return tickets that have the custom ticket field named in field_name set to the value passed in field_value.

It must be passed together with field_value in order to filter tickets.

Example:

"Browser"

field_value
string

Return tickets that have the custom ticket field named in field_name set to the value passed in field_value.

It must be passed together with field_name in order to filter tickets.

For fields of the multi_option kind, pass the options as a comma-separated string, such as Chrome,Firefox.

Example:

"Chrome"

range_type
enum<string>

Return only tickets created within this time range. Use custom together with start_date and end_date for an exact range.

Available options:
last_7_days,
last_30_days,
last_24_hours,
this_week,
last_week,
this_month,
last_month,
this_quarter,
last_quarter,
this_year,
last_year,
all_time,
custom
Example:

"last_30_days"

start_date
string<date>

Start date for custom date range (YYYY-MM-DD format). Required when range_type is custom.

Example:

"2025-10-01"

end_date
string<date>

End date for custom date range (YYYY-MM-DD format). Required when range_type is custom.

Example:

"2025-10-31"

sort
enum<string>
default:created_at

Column to sort tickets by. Defaults to created_at.

Available options:
created_at,
updated_at
Example:

"created_at"

order
enum<string>
default:desc

Direction to sort tickets in. Defaults to desc, newest first.

Available options:
asc,
desc
Example:

"desc"

Response

OK - Request succeeded

tickets
object[]
pagination
object