List Tickets

List tickets

GET/api/tickets

Use it in a workflow

Add a step and choose the Gorgias connector.
Pick the List Tickets action (under Tickets).
Fill in the fields below, then reference the result from later steps as {{listTickets.response.data}}.

Request

Query parameters

order_bystring

Attribute used to order tickets.

One ofcreated_datetime:asccreated_datetime:descupdated_datetime:ascupdated_datetime:descDefault "created_datetime:desc"

cursorstring

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

customer_idinteger

The ID of a [customer](#the-customer-object) used to select their tickets.

trashedboolean

Whether to include trashed tickets in the response.

Default true

external_idstring

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

limitinteger

Maximum number of tickets to return.

Default 30

view_idinteger

The ID of a [view](#the-view-object) used to select tickets matching the filters of this one.

rule_idinteger

The ID of a [rule](#the-rule-object) used to select tickets matching the filters of this one.

ticket_idsarray<integer>

The IDs of tickets to select.

Default []

Response

Returns 200 with an object. Read it in later steps with {{listTickets.response.data.<field>}}.

objectstring

uristring

dataarray<object>

idintegerrequired

ID of the ticket.

uristringrequired

URI of the ticket.

external_idstringrequired

External ID of the ticket in a foreign system. This field is not used by Gorgias, feel free to set it as you wish.

languagestringrequired

The language primarily used in the ticket. The language is automatically detected on the first messages by Gorgias if not set explicitly. Once the language has been set, it won't be updated according to future messages.

statusstring

One ofopenclosed

prioritystring

One ofcriticalhighnormallow

channeloneOfrequired

The channel used to initiate the conversation with the customer.

viastringrequired

One ofaircallapichatcontact_formemailfacebookfacebook-mentionfacebook-messengerfacebook-recommendationsformgorgias_chathelp-centerhelpdeskinstagraminstagram-ad-commentinstagram-commentinstagram-direct-messageinstagram-mentioninternal-noteoffline_capturephoneruleself_serviceshopifysmstwiliotwittertwitter-direct-messagewhatsappyotpoyotpo-reviewzendesk

from_agentbooleanrequired

Whether the first message of the ticket was sent by your company to a customer, or the opposite.

customerobjectrequired6 fields

assignee_userobjectrequired7 fields

assignee_teamobjectrequired3 fields

subjectstringrequired

The subject of the ticket.

summaryobject4 fields

excerptstringrequired

Excerpt of the last message of the ticket.

integrationsarray<object>required3 fields

Messaging integrations involved in the ticket.

metaanyrequired

tagsarray<object>required3 fields

[Tags](#the-tag-object) linked to the ticket.

messages_countintegerrequired

The number of messages in the ticket.

is_unreadbooleanrequired

Whether the ticket is unread for you.

spambooleanrequired

Whether the ticket is considered as spam or not.

created_datetimestring (date-time)required

When the ticket was created.

opened_datetimestring (date-time)required

When the ticket was opened for the first time by a user.

last_received_message_datetimestring (date-time)required

When the last customer's message was sent.

last_message_datetimestring (date-time)required

When the last message was sent.

last_sent_message_not_deliveredbooleanrequired

(beta) The last sent message was not delivered.

updated_datetimestring (date-time)required

When the ticket was lastly updated.

closed_datetimestring (date-time)required

When the ticket was closed.

snooze_datetimestring (date-time)required

When the ticket will be re-opened.

trashed_datetimestring (date-time)required

When the ticket was moved to the trash.

custom_fieldsobject

The custom fields associated with the ticket.

metaobject

prev_cursorstringrequired

next_cursorstringrequired

total_resourcesintegerrequired

json

{
  "object": "string",
  "uri": "string",
  "data": [
    {
      "id": 0,
      "uri": "string",
      "external_id": "string",
      "language": "string",
      "channel": null,
      "via": "aircall",
      "from_agent": false,
      "customer": {
        "id": 0,
        "email": "string",
        "name": "string",
        "firstname": "string",
        "lastname": "string",
        "meta": null
      },
      "assignee_user": {
        "id": 0,
        "email": "string",
        "name": "string",
        "firstname": "string",
        "lastname": "string",
        "meta": null,
        "bio": "string"
      },
      "assignee_team": {
        "id": 0,
        "name": "string",
        "decoration": {}
      },
      "subject": "string",
      "excerpt": "string"
    }
  ],
  "meta": {
    "prev_cursor": "string",
    "next_cursor": "string",
    "total_resources": 0
  }
}

Need more? See the Gorgias guide for connection setup and behaviour shared by every action.

Was this page helpful?