v1

latestOpenAPI 3.1.02026-07-24111290748.0 KB

Tickets

List tickets

List tickets, paginated and ordered by the attribute of the given view.

get/api/tickets

Query parameters

order_by'created_datetime:asc' | 'created_datetime:desc' | 'updated_datetime:asc' | 'updated_datetime:desc'

Attribute used to order tickets.

cursorstring

Example:cHJldl9fNl9fMjAyMS0wMy0wMyAwNjowMDowMA==

Value indicating your position in the list of all tickets. If omitted, the first tickets of the list will be returned.

customer_idinteger

Example:4

The ID of a customer used to select their tickets.

trashedboolean

Whether to include trashed tickets in the response.

external_idstring

Example:ticket-ge432d

ID of the ticket in a foreign system you're looking for.

limitinteger

Maximum number of tickets to return.

view_idinteger

Example:21

The ID of a view used to select tickets matching the filters of this one.

rule_idinteger

Example:21

The ID of a rule used to select tickets matching the filters of this one.

ticket_idsinteger[]

The IDs of tickets to select.

[
  1,
  3,
  2
]

Response

A list of tickets.

objectstring required

uristring required

Example response

{
  "data": [
    {
      "id": 123,
      "external_id": "RETURN#4213",
      "language": "fr",
      "customer": {
        "id": 3924,
        "email": "john@example.com",
        "name": "John Smith",
        "firstname": "John",
        "lastname": "Smith",
        "meta": {
          "position": "engineer"
        }
      },
      "assignee_user": {
        "id": 3924,
        "email": "steve@company.com",
        "name": "Steve Frazelli",
        "firstname": "Steve",
        "lastname": "Frazeli",
        "meta": {
          "avatar_url": "https://avatars.example.com/steve-profile.jpeg",
          "position": "engineer"
        },
        "bio": "Full stack developer at Gorgias"
      },
      "assignee_team": {
        "id": 123,
        "name": "Warehouse team"
      },
      "subject": "Can I get a refund?",
      "summary": {
        "content": "The customer is asking for a refund.",
        "created_datetime": "2020-01-27T10:42:21.932637",
        "updated_datetime": "2020-01-27T10:42:21.932637",
        "triggered_by": 1
      },
      "excerpt": "Hi, I was supposed to receive a refund 2 days ago but I've realized that the credit card that is registered on my account has expired. How can I plea",
      "integrations": [
        {
          "name": "Main support",
          "address": "support@brand.com"
        }
      ],
      "tags": [
        {
          "decoration": {
            "color": "#F58D86"
          },
          "name": "urgent"
        }
      ],
      "messages_count": 4,
      "is_unread": true,
      "created_datetime": "2019-07-05T14:42:00.384938",
      "opened_datetime": "2019-07-05T15:22:46.472436",
      "last_received_message_datetime": "2020-01-27T10:42:21.468912",
      "last_message_datetime": "2020-02-01T19:12:32.432197",
      "updated_datetime": "2020-01-27T10:42:21.932637"
    }
  ]
}