Skip to main content
GET
List tickets

Authorizations

Authorization
string
header
required

API token in the sk_live_… format.

Query Parameters

page
integer
default:1

Page number, starting at 1. An invalid value is treated as 1.

Required range: x >= 1
perPage
integer
default:20

Number of items per page. The maximum depends on the environment (default 100).

Required range: 1 <= x <= 100
status
string

Filters by ticket status. Accepts several values separated by commas (e.g. open,pending).

Example:

"open,pending"

queueId
integer

Only tickets in this queue.

userId
integer

Only tickets assigned to this agent.

channelId
integer
contactId
integer
tagId
integer

Only tickets with this tag.

from
string<date>

Start of the period, in the company's time zone.

to
string<date>

End of the period, in the company's time zone.

dateField
enum<string>
default:created

Sets which date the period filter uses: the creation date or the last update date.

Available options:
created,
updated

Response

200 - application/json

OK

data
object[]
meta
object
Example: