Skip to main content
GET
List tickets

Authorizations

Authorization
string
header
required

API key from your account settings

Path Parameters

agentId
string
required

The agent ID

Minimum string length: 1
Example:

"5QHA6VB-DIAbBhxwqxfdi"

Query Parameters

cursor
string

Opaque cursor from a previous response to fetch the next page

Example:

"eyJ0IjoiMjAyNC0wMS0xNVQxMDozMDowMC4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="

limit
integer
default:20

Number of items per page (1 to 100, default 20)

Required range: 1 <= x <= 100
Example:

20

status
string

Comma-separated status categories (is-any-of). Categories: new, on_you, on_customer, on_hold, closed, cancelled.

Example:

"new,on_you"

channel
string

Comma-separated channels (is-any-of).

Example:

"email,api"

assigneeId

Filter by assigned agent user id. Pass none for unassigned tickets.

Available options:
none
teamId

Filter by team id. Pass none for tickets with no team.

Available options:
none
createdAfter
string<date-time>

Only tickets created at or after this ISO 8601 timestamp.

Example:

"2026-07-01T00:00:00Z"

createdBefore
string<date-time>

Only tickets created at or before this ISO 8601 timestamp.

Example:

"2026-07-31T23:59:59Z"

sortBy
enum<string>
default:updatedAt

Sort field. updatedAt and lastMessageAt fall back to createdAt when unset. Sorting by a mutable field means a page window is not a snapshot. Pollers should use sortBy=updatedAt&order=asc with a high-water mark.

Available options:
createdAt,
updatedAt,
lastMessageAt
Example:

"updatedAt"

order
enum<string>
default:desc

Sort direction. Defaults to desc, newest first. A cursor is only valid for the sortBy/order it was issued with; changing either mid-walk is a 400.

Available options:
asc,
desc
Example:

"desc"

includeTotal
enum<string>
default:false

When true, the response includes pagination.total (costs an extra count query).

Available options:
true,
false
Example:

"false"

Response

Paginated list of tickets

data
object[]
required
pagination
object
required