Developers
Tickets9

List tickets

GET/support/tickets

Returns the support tickets in the account, using cursor-based pagination.

The collection can be filtered by user, product, support department, status, a text search, and last update time, and sorted by updated_at.

If the credentials are restricted to specific users or products, only tickets within that scope are returned.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Query Parameters

limit?integer

Maximum number of items to return, from 1 to 200.

Range1 <= value <= 200
cursor?string

Cursor for the next page, taken from page.next_cursor of the previous response.

sort?string

Sort order. A leading - sorts in descending order.

Value in

  • "updated_at"
  • "-updated_at"
user_id?string

Only tickets opened by the user with this public ID.

department_id?string

Only tickets assigned to the department with this public ID.

status?string

Only tickets with this status.

Value in

  • "open"
  • "closed"
product_id?string

Only tickets about the product with this public ID.

q?string

Text search term.

updated_after?string

Only items updated after this date and time (ISO 8601).

Formatdate-time

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/support/tickets"
{  "data": [    {      "anonymous": {        "document": "string",        "email": "string",        "name": "string",        "whatsapp": "string"      },      "created_at": "2019-08-24T14:15:22Z",      "department_id": "string",      "id": "string",      "last_reply_at": "2019-08-24T14:15:22Z",      "object": "ticket",      "product_id": "string",      "replies_count": 0,      "revision": "string",      "status": "open",      "subject": "string",      "updated_at": "2019-08-24T14:15:22Z",      "user": {        "email": "user@example.com",        "id": "string",        "name": "string"      }    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Tickets9

Tickets in API v3: list tickets, create a ticket, retrieve a ticket, update a ticket, list ticket replies, create a ticket reply, retrieve a ticket reply, update a ticket reply, delete a ticket reply.

Create a ticket POST

Opens a support ticket on behalf of the specified user. The ticket is owned by that user, but its first message is attributed to the credential that made the request, not to the user. If `user_id`, `department_id`, or `product_id` does not reference a resource accessible with the current credentials, the request is rejected with a validation error for that field.