Gorgias

App · 26 actions

Work with your Gorgias helpdesk: create, read, update and delete tickets, add internal notes and tags, manage customers and tags, and look up users, teams, views and the activity log.

Actions

ActionWhat it does
Add customer messageRecord a message from the ticket's customer, as if they had written back.
Add internal noteAdd a note to a ticket that only your team sees.
Add ticket tagsPut tags on a ticket by name.
Create customerAdd a customer, identified by their email address.
Create tagCreate a tag with an optional description and colour.
Create ticketOpen a ticket for a customer with their first message.
Delete customerDelete a customer, together with their tickets.
Delete tagDelete a tag.
Delete ticketDelete a ticket and its messages for good.
Get accountGet the Gorgias account the connection signs in to: its domain, status and when it was created.
Get customerGet one customer with their email and other channels.
Get ticketGet one ticket with its customer, assignee, tags, status and timestamps.
Get userGet one user.
List customersList customers, optionally those matching an email address, name or external id.
List eventsRead the activity log: what happened to tickets, customers and tags, filtered by kind of record, event type or time.
List tagsList the account's tags with how many tickets use each, optionally those whose name contains some text.
List teamsList the teams that tickets can be assigned to.
List ticket messagesList the messages and internal notes on a ticket, oldest first.
List ticket tagsList the tags on a ticket.
List ticketsList tickets, newest first, optionally those of one view or customer.
List usersList the people who work in Gorgias, optionally those whose name or email matches some text or who have certain roles.
List viewsList the saved lists (views) in Gorgias, such as Open or Unassigned tickets.
Remove ticket tagsTake tags off a ticket by name.
Update customerChange a customer's name, email, external id, language or time zone.
Update tagRename a tag or change its description or colour.
Update ticketChange a ticket's subject, status, priority, assignee or snooze time.

Add customer message

Record a message from the ticket's customer, as if they had written back. Nothing is sent to anyone.

Inputs

Ticket IDticket_idtextRequired
The ticket's number, from 'List tickets' or 'Create ticket'.
MessagemessagetextRequired
What the customer wrote.

Outputs

messageobject
The message
Example output
{
  "message": {
    "body_html": "<p>Checked with the warehouse.</p>",
    "body_text": "Any news on my order?",
    "channel": "api",
    "created_datetime": "2026-10-15T09:05:00",
    "failed_datetime": null,
    "from_agent": false,
    "id": 5001,
    "integration_id": null,
    "public": true,
    "receiver": null,
    "sender": {
      "email": "agent@example.com",
      "firstname": "Sam",
      "id": 11,
      "name": "Sam Agent"
    },
    "sent_datetime": "2026-10-15T09:05:00",
    "stripped_text": null,
    "subject": null,
    "ticket_id": 123,
    "uri": "/api/tickets/123/messages/5001/",
    "via": "api"
  }
}

Add internal note

Add a note to a ticket that only your team sees. The customer is never emailed.

Inputs

Ticket IDticket_idtextRequired
The ticket's number, from 'List tickets' or 'Create ticket'.
NotenotetextRequired
The text of the note.
Written byauthor_idtext
The user the note is shown as written by. Defaults to the user who made the API key.

Outputs

messageobject
The message
Example output
{
  "message": {
    "body_html": "<p>Checked with the warehouse.</p>",
    "body_text": "Checked with the warehouse.",
    "channel": "internal-note",
    "created_datetime": "2026-10-15T09:05:00",
    "failed_datetime": null,
    "from_agent": true,
    "id": 5001,
    "integration_id": null,
    "public": false,
    "receiver": null,
    "sender": {
      "email": "agent@example.com",
      "firstname": "Sam",
      "id": 11,
      "name": "Sam Agent"
    },
    "sent_datetime": "2026-10-15T09:05:00",
    "stripped_text": null,
    "subject": null,
    "ticket_id": 123,
    "uri": "/api/tickets/123/messages/5001/",
    "via": "internal-note"
  }
}

Add ticket tags

Put tags on a ticket by name. A name that does not exist yet is created. Returns the ticket's tags afterwards.

Inputs

Ticket IDticket_idtextRequired
The ticket's number, from 'List tickets' or 'Create ticket'.
TagstagslistRequired
Tag names. Pick existing tags or type new names.

Outputs

countnumber
How many tags the ticket has
tagslist
The ticket's tags
ticket_idnumber
The ticket
Example output
{
  "count": 1,
  "tags": [
    {
      "created_datetime": "2026-10-01T09:00:00",
      "decoration": {
        "color": "#F9A825"
      },
      "deleted_datetime": null,
      "description": "Refund requests",
      "id": 77,
      "name": "refund",
      "uri": "/api/tags/77/",
      "usage": 4
    }
  ],
  "ticket_id": 123
}

Create customer

Add a customer, identified by their email address.

Inputs

EmailemailtextRequired
The customer's email address.
Namenametext
The customer's full name.
External IDexternal_idtext
The customer's id in another system.
Languagelanguagetext
Their language code, such as en or fr.
Time zonetimezonetext
Their time zone, such as America/New_York.

Outputs

customerobject
The customer
Example output
{
  "customer": {
    "channels": [
      {
        "address": "jo@example.com",
        "id": 9,
        "preferred": true,
        "type": "email"
      }
    ],
    "created_datetime": "2026-10-15T09:00:00",
    "email": "jo@example.com",
    "external_id": null,
    "firstname": "Jo",
    "id": 3924,
    "language": "en",
    "lastname": "Bloggs",
    "name": "Jo Bloggs",
    "note": null,
    "timezone": "America/New_York",
    "updated_datetime": "2026-10-15T09:00:00"
  }
}

Create tag

Create a tag with an optional description and colour.

Inputs

NamenametextRequired
The tag's name. Names are case sensitive.
Descriptiondescriptiontext
A short note on what the tag is for.
Colourcolortext
The tag's colour as a hex code.

Outputs

tagobject
The tag
Example output
{
  "tag": {
    "created_datetime": "2026-10-01T09:00:00",
    "decoration": {
      "color": "#F9A825"
    },
    "deleted_datetime": null,
    "description": "Refund requests",
    "id": 77,
    "name": "refund",
    "uri": "/api/tags/77/",
    "usage": 4
  }
}

Create ticket

Open a ticket for a customer with their first message. Nobody is emailed, and a customer with that address is created if there is none.

Inputs

Customer emailcustomer_emailtextRequired
The email address of the customer. A customer with this address is created if there is none.
Customer namecustomer_nametext
The customer's full name, used when the customer is new.
Subjectsubjecttext
The ticket's subject line.
MessagemessagetextRequired
What the customer wrote. It becomes the ticket's first message, unless it is an internal note (below).
Start with an internal noteas_internal_notetrue/false
Beta. Turn on when the team is opening the ticket about the customer (a delivery problem to follow up, say): the message is then a note only the team sees, from the connected user, instead of the customer's first message.
Statusstatustext
Whether the ticket starts open or closed. Defaults to open.One of: open, closed.
Priorityprioritytext
How urgent the ticket is. Defaults to normal.One of: normal (Normal (default)), low, high, critical.
Tagstagslist
Tags to put on the ticket. Pick existing tags or type new names.
Assign to userassignee_user_idtext
The user who should own the ticket.
Assign to teamassignee_team_idtext
The team that should own the ticket.
External IDexternal_idtext
The ticket's id in another system, to find it by later.

Outputs

ticketobject
The ticket
Example output
{
  "ticket": {
    "assignee_team": null,
    "assignee_user": null,
    "channel": "api",
    "closed_datetime": null,
    "created_datetime": "2026-10-15T09:00:00",
    "customer": {
      "email": "jo@example.com",
      "firstname": "Jo",
      "id": 3924,
      "name": "Jo Bloggs"
    },
    "external_id": null,
    "from_agent": false,
    "id": 123,
    "is_unread": true,
    "language": "en",
    "last_message_datetime": "2026-10-15T09:00:00",
    "last_received_message_datetime": "2026-10-15T09:00:00",
    "messages_count": 1,
    "opened_datetime": null,
    "priority": "normal",
    "snooze_datetime": null,
    "spam": false,
    "status": "open",
    "subject": "Where is my order?",
    "tags": [
      {
        "created_datetime": "2026-10-01T09:00:00",
        "decoration": {
          "color": "#F9A825"
        },
        "deleted_datetime": null,
        "description": "Refund requests",
        "id": 77,
        "name": "refund",
        "uri": "/api/tags/77/",
        "usage": 4
      }
    ],
    "trashed_datetime": null,
    "updated_datetime": "2026-10-15T09:00:00",
    "uri": "/api/tickets/123/",
    "via": "api"
  }
}

Delete customer

Delete a customer, together with their tickets.

Inputs

Customer IDcustomer_idtextRequired
The customer's number, from 'List customers' or 'Create customer'.

Outputs

customer_idnumber
The customer deleted
deletedtrue/false
Always true once deleted
Example output
{
  "customer_id": 3924,
  "deleted": true
}

Delete tag

Delete a tag. It comes off every ticket that had it.

Inputs

Tagtag_idtextRequired
The tag. Pick one, or give its id from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
tag_idnumber
The tag deleted
Example output
{
  "deleted": true,
  "tag_id": 77
}

Delete ticket

Delete a ticket and its messages for good.

Inputs

Ticket IDticket_idtextRequired
The ticket's number, from 'List tickets' or 'Create ticket'.

Outputs

deletedtrue/false
Always true once deleted
ticket_idnumber
The ticket deleted
Example output
{
  "deleted": true,
  "ticket_id": 123
}

Get account

Get the Gorgias account the connection signs in to: its domain, status and when it was created.

Inputs

None.

Outputs

accountobject
The account
Example output
{
  "account": {
    "created_datetime": "2026-09-01T09:00:00",
    "deactivated_datetime": null,
    "domain": "acme",
    "status": {
      "status": "active"
    },
    "uri": "/api/account/"
  }
}

Get customer

Get one customer with their email and other channels.

Inputs

Customer IDcustomer_idtextRequired
The customer's number, from 'List customers' or 'Create customer'.

Outputs

customerobject
The customer
Example output
{
  "customer": {
    "channels": [
      {
        "address": "jo@example.com",
        "id": 9,
        "preferred": true,
        "type": "email"
      }
    ],
    "created_datetime": "2026-10-15T09:00:00",
    "email": "jo@example.com",
    "external_id": null,
    "firstname": "Jo",
    "id": 3924,
    "language": "en",
    "lastname": "Bloggs",
    "name": "Jo Bloggs",
    "note": null,
    "timezone": "America/New_York",
    "updated_datetime": "2026-10-15T09:00:00"
  }
}

Get ticket

Get one ticket with its customer, assignee, tags, status and timestamps.

Inputs

Ticket IDticket_idtextRequired
The ticket's number, from 'List tickets' or 'Create ticket'.

Outputs

ticketobject
The ticket
Example output
{
  "ticket": {
    "assignee_team": null,
    "assignee_user": null,
    "channel": "api",
    "closed_datetime": null,
    "created_datetime": "2026-10-15T09:00:00",
    "customer": {
      "email": "jo@example.com",
      "firstname": "Jo",
      "id": 3924,
      "name": "Jo Bloggs"
    },
    "external_id": null,
    "from_agent": false,
    "id": 123,
    "is_unread": true,
    "language": "en",
    "last_message_datetime": "2026-10-15T09:00:00",
    "last_received_message_datetime": "2026-10-15T09:00:00",
    "messages_count": 1,
    "opened_datetime": null,
    "priority": "normal",
    "snooze_datetime": null,
    "spam": false,
    "status": "open",
    "subject": "Where is my order?",
    "tags": [
      {
        "created_datetime": "2026-10-01T09:00:00",
        "decoration": {
          "color": "#F9A825"
        },
        "deleted_datetime": null,
        "description": "Refund requests",
        "id": 77,
        "name": "refund",
        "uri": "/api/tags/77/",
        "usage": 4
      }
    ],
    "trashed_datetime": null,
    "updated_datetime": "2026-10-15T09:00:00",
    "uri": "/api/tickets/123/",
    "via": "api"
  }
}

Get user

Get one user. Leave the user empty to get the one the connection acts as.

Inputs

Usergorgias_user_idtext
The user. Pick one, or leave empty for the user who made the API key.

Outputs

userobject
The user
Example output
{
  "user": {
    "active": true,
    "created_datetime": "2026-09-01T09:00:00",
    "email": "agent@example.com",
    "firstname": "Sam",
    "id": 11,
    "language": "en",
    "lastname": "Agent",
    "name": "Sam Agent",
    "role": {
      "name": "admin"
    },
    "timezone": "America/New_York"
  }
}

List customers

List customers, optionally those matching an email address, name or external id. Returns one page.

Inputs

Emailemailtext
Only the customer with this email address.
Namenametext
Only customers with this full name.
External IDexternal_idtext
Only the customer with this id from another system.
Orderorder_bytext
How to sort the customers. Defaults to newest first.One of: created_datetime:desc (Newest first (default)), created_datetime:asc (Oldest first), updated_datetime:desc (Recently updated first), updated_datetime:asc (Least recently updated first).
Page sizelimitnumber
How many to return, 1 to 100. Gorgias's default is 30.From 1 to 100.
Page cursorcursortext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many on this page
customerslist
The customers
next_cursortext
Pass as 'cursor' for the next page; empty on the last one
previous_cursortext
Pass as 'cursor' for the previous page; empty on the first
Example output
{
  "count": 1,
  "customers": [
    {
      "channels": [
        {
          "address": "jo@example.com",
          "id": 9,
          "preferred": true,
          "type": "email"
        }
      ],
      "created_datetime": "2026-10-15T09:00:00",
      "email": "jo@example.com",
      "external_id": null,
      "firstname": "Jo",
      "id": 3924,
      "language": "en",
      "lastname": "Bloggs",
      "name": "Jo Bloggs",
      "note": null,
      "timezone": "America/New_York",
      "updated_datetime": "2026-10-15T09:00:00"
    }
  ],
  "next_cursor": "",
  "previous_cursor": ""
}

List events

Read the activity log: what happened to tickets, customers and tags, filtered by kind of record, event type or time. Returns one page.

Inputs

Kind of recordobject_typetext
Only events about this kind of record.One of: Ticket, TicketMessage (Ticket message), Customer, Tag, Team, User, View, Macro, Rule, Integration, SatisfactionSurvey (Satisfaction survey).
Record IDobject_idtext
Only events about this record. Needs the kind above.
Event typestypeslist
Only these kinds of event.One or more of: ticket-created (Ticket created), ticket-updated (Ticket updated), ticket-closed (Ticket closed), ticket-reopened (Ticket reopened), ticket-assigned (Ticket assigned to a user), ticket-unassigned (Ticket unassigned), ticket-team-assigned (Ticket assigned to a team), ticket-tags-added (Tags added to a ticket), ticket-tags-removed (Tags removed from a ticket), ticket-message-created (Ticket message created), and 7 more.
Fromfrom_timedate and time
Only events at or after this time.
Untiluntil_timedate and time
Only events at or before this time.
Orderorder_bytext
How to sort the events. Defaults to newest first.One of: created_datetime:desc (Newest first (default)), created_datetime:asc (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100. Gorgias's default is 30.From 1 to 100.
Page cursorcursortext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many on this page
eventslist
The events
next_cursortext
Pass as 'cursor' for the next page; empty on the last one
previous_cursortext
Pass as 'cursor' for the previous page; empty on the first
Example output
{
  "count": 1,
  "events": [
    {
      "created_datetime": "2026-10-15T09:00:00",
      "id": 880001,
      "object_id": 123,
      "object_type": "Ticket",
      "type": "ticket-created",
      "uri": "/api/events/880001/",
      "user_id": 11
    }
  ],
  "next_cursor": "",
  "previous_cursor": ""
}

List tags

List the account's tags with how many tickets use each, optionally those whose name contains some text.

Inputs

Name containssearchtext
Only tags whose name contains this text.
Orderorder_bytext
How to sort the tags. Defaults to name, A to Z.One of: name:asc (Name, A to Z (default)), name:desc (Name, Z to A), created_datetime:desc (Newest first), created_datetime:asc (Oldest first), usage:desc,name:desc (Most used first), usage:asc,name:asc (Least used first).
Page sizelimitnumber
How many to return, 1 to 100. Gorgias's default is 30.From 1 to 100.
Page cursorcursortext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many on this page
next_cursortext
Pass as 'cursor' for the next page; empty on the last one
previous_cursortext
Pass as 'cursor' for the previous page; empty on the first
tagslist
The tags
Example output
{
  "count": 1,
  "next_cursor": "",
  "previous_cursor": "",
  "tags": [
    {
      "created_datetime": "2026-10-01T09:00:00",
      "decoration": {
        "color": "#F9A825"
      },
      "deleted_datetime": null,
      "description": "Refund requests",
      "id": 77,
      "name": "refund",
      "uri": "/api/tags/77/",
      "usage": 4
    }
  ]
}

List teams

List the teams that tickets can be assigned to.

Inputs

Orderorder_bytext
How to sort the teams. Defaults to name, A to Z.One of: name:asc (Name, A to Z (default)), name:desc (Name, Z to A), created_datetime:desc (Newest first), created_datetime:asc (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100. Gorgias's default is 30.From 1 to 100.
Page cursorcursortext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many on this page
next_cursortext
Pass as 'cursor' for the next page; empty on the last one
previous_cursortext
Pass as 'cursor' for the previous page; empty on the first
teamslist
The teams
Example output
{
  "count": 1,
  "next_cursor": "",
  "previous_cursor": "",
  "teams": [
    {
      "created_datetime": "2026-09-01T09:00:00",
      "description": "First line",
      "id": 4,
      "name": "Support",
      "uri": "/api/teams/4/"
    }
  ]
}

List ticket messages

List the messages and internal notes on a ticket, oldest first. Returns one page.

Inputs

Ticket IDticket_idtextRequired
The ticket's number, from 'List tickets' or 'Create ticket'.
Orderorder_bytext
How to sort the messages. Defaults to oldest first.One of: created_datetime:asc (Oldest first (default)), created_datetime:desc (Newest first).
Page sizelimitnumber
How many to return, 1 to 100. Gorgias's default is 30.From 1 to 100.
Page cursorcursortext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many on this page
messageslist
The messages
next_cursortext
Pass as 'cursor' for the next page; empty on the last one
previous_cursortext
Pass as 'cursor' for the previous page; empty on the first
ticket_idnumber
The ticket
Example output
{
  "count": 1,
  "messages": [
    {
      "body_html": "<p>Checked with the warehouse.</p>",
      "body_text": "Checked with the warehouse.",
      "channel": "internal-note",
      "created_datetime": "2026-10-15T09:05:00",
      "failed_datetime": null,
      "from_agent": true,
      "id": 5001,
      "integration_id": null,
      "public": false,
      "receiver": null,
      "sender": {
        "email": "agent@example.com",
        "firstname": "Sam",
        "id": 11,
        "name": "Sam Agent"
      },
      "sent_datetime": "2026-10-15T09:05:00",
      "stripped_text": null,
      "subject": null,
      "ticket_id": 123,
      "uri": "/api/tickets/123/messages/5001/",
      "via": "internal-note"
    }
  ],
  "next_cursor": "",
  "previous_cursor": "",
  "ticket_id": 123
}

List ticket tags

List the tags on a ticket.

Inputs

Ticket IDticket_idtextRequired
The ticket's number, from 'List tickets' or 'Create ticket'.

Outputs

countnumber
How many tags the ticket has
tagslist
The ticket's tags
ticket_idnumber
The ticket
Example output
{
  "count": 1,
  "tags": [
    {
      "created_datetime": "2026-10-01T09:00:00",
      "decoration": {
        "color": "#F9A825"
      },
      "deleted_datetime": null,
      "description": "Refund requests",
      "id": 77,
      "name": "refund",
      "uri": "/api/tags/77/",
      "usage": 4
    }
  ],
  "ticket_id": 123
}

List tickets

List tickets, newest first, optionally those of one view or customer. Gets one page; to see more, run it again with the next page it gives.

Inputs

Viewview_idtext
Only tickets matching this view's filters. Views are the saved lists in Gorgias, such as Open or Unassigned.
Customer IDcustomer_idtext
Only this customer's tickets. Use 'List customers' to find one.
External IDexternal_idtext
Only the ticket with this id from another system.
Include trashed ticketsinclude_trashedtrue/false
Also return tickets that are in the trash.Default: false.
Orderorder_bytext
How to sort the tickets. Defaults to newest first.One of: created_datetime:desc (Newest first (default)), created_datetime:asc (Oldest first), updated_datetime:desc (Recently updated first), updated_datetime:asc (Least recently updated first).
Page sizelimitnumber
How many to return, 1 to 100. Gorgias's default is 30.From 1 to 100.
Page cursorcursortext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many on this page
next_cursortext
Pass as 'cursor' for the next page; empty on the last one
previous_cursortext
Pass as 'cursor' for the previous page; empty on the first
ticketslist
The tickets
Example output
{
  "count": 1,
  "next_cursor": "",
  "previous_cursor": "",
  "tickets": [
    {
      "assignee_team": null,
      "assignee_user": null,
      "channel": "api",
      "closed_datetime": null,
      "created_datetime": "2026-10-15T09:00:00",
      "customer": {
        "email": "jo@example.com",
        "firstname": "Jo",
        "id": 3924,
        "name": "Jo Bloggs"
      },
      "external_id": null,
      "from_agent": false,
      "id": 123,
      "is_unread": true,
      "language": "en",
      "last_message_datetime": "2026-10-15T09:00:00",
      "last_received_message_datetime": "2026-10-15T09:00:00",
      "messages_count": 1,
      "opened_datetime": null,
      "priority": "normal",
      "snooze_datetime": null,
      "spam": false,
      "status": "open",
      "subject": "Where is my order?",
      "tags": [
        {
          "created_datetime": "2026-10-01T09:00:00",
          "decoration": {
            "color": "#F9A825"
          },
          "deleted_datetime": null,
          "description": "Refund requests",
          "id": 77,
          "name": "refund",
          "uri": "/api/tags/77/",
          "usage": 4
        }
      ],
      "trashed_datetime": null,
      "updated_datetime": "2026-10-15T09:00:00",
      "uri": "/api/tickets/123/",
      "via": "api"
    }
  ]
}

List users

List the people who work in Gorgias, optionally those whose name or email matches some text or who have certain roles.

Inputs

Name or email containssearchtext
Only users whose name or email contains this text.
Rolesroleslist
Only users with one of these roles.One or more of: admin, agent, basic-agent (Basic agent), lite-agent (Lite agent), observer-agent (Observer agent), internal-agent (Internal agent), bot.
Orderorder_bytext
How to sort the users. Defaults to name, A to Z.One of: name:asc (Name, A to Z (default)), name:desc (Name, Z to A), created_datetime:desc (Newest first), created_datetime:asc (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100. Gorgias's default is 30.From 1 to 100.
Page cursorcursortext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many on this page
next_cursortext
Pass as 'cursor' for the next page; empty on the last one
previous_cursortext
Pass as 'cursor' for the previous page; empty on the first
userslist
The users
Example output
{
  "count": 1,
  "next_cursor": "",
  "previous_cursor": "",
  "users": [
    {
      "active": true,
      "created_datetime": "2026-09-01T09:00:00",
      "email": "agent@example.com",
      "firstname": "Sam",
      "id": 11,
      "language": "en",
      "lastname": "Agent",
      "name": "Sam Agent",
      "role": {
        "name": "admin"
      },
      "timezone": "America/New_York"
    }
  ]
}

List views

List the saved lists (views) in Gorgias, such as Open or Unassigned tickets. Use one's id in 'List tickets'.

Inputs

Kindcategorytext
Built-in views or the ones people made. Defaults to both.One of: user (Views people made), system (Built-in views).
Page sizelimitnumber
How many to return, 1 to 100. Gorgias's default is 30.From 1 to 100.
Page cursorcursortext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many on this page
next_cursortext
Pass as 'cursor' for the next page; empty on the last one
previous_cursortext
Pass as 'cursor' for the previous page; empty on the first
viewslist
The views
Example output
{
  "count": 1,
  "next_cursor": "",
  "previous_cursor": "",
  "views": [
    {
      "category": "system",
      "created_datetime": "2026-09-01T09:00:00",
      "id": 21,
      "name": "Open tickets",
      "order_by": "created_datetime",
      "order_dir": "desc",
      "type": "ticket-list",
      "uri": "/api/views/21/",
      "visibility": "public"
    }
  ]
}

Remove ticket tags

Take tags off a ticket by name. The tags themselves are kept. Returns the ticket's tags afterwards.

Inputs

Ticket IDticket_idtextRequired
The ticket's number, from 'List tickets' or 'Create ticket'.
TagstagslistRequired
Tag names. Pick existing tags or type new names.

Outputs

countnumber
How many tags the ticket has
tagslist
The ticket's tags
ticket_idnumber
The ticket
Example output
{
  "count": 0,
  "tags": [],
  "ticket_id": 123
}

Update customer

Change a customer's name, email, external id, language or time zone. Fields left empty are kept.

Inputs

Customer IDcustomer_idtextRequired
The customer's number, from 'List customers' or 'Create customer'.
Namenametext
A new full name. Leave empty to keep it.
Emailemailtext
A new primary email address. Leave empty to keep it.
External IDexternal_idtext
A new external id. Leave empty to keep it.
Languagelanguagetext
A new language code. Leave empty to keep it.
Time zonetimezonetext
A new time zone. Leave empty to keep it.

Outputs

customerobject
The customer
Example output
{
  "customer": {
    "channels": [
      {
        "address": "jo@example.com",
        "id": 9,
        "preferred": true,
        "type": "email"
      }
    ],
    "created_datetime": "2026-10-15T09:00:00",
    "email": "jo@example.com",
    "external_id": null,
    "firstname": "Jo",
    "id": 3924,
    "language": "en",
    "lastname": "Bloggs",
    "name": "Joanne Bloggs",
    "note": null,
    "timezone": "America/New_York",
    "updated_datetime": "2026-10-15T09:00:00"
  }
}

Update tag

Rename a tag or change its description or colour. Fields left empty are kept.

Inputs

Tagtag_idtextRequired
The tag. Pick one, or give its id from an earlier step.
Namenametext
A new name. Leave empty to keep it.
Descriptiondescriptiontext
A new description. Leave empty to keep it.
Colourcolortext
A new colour as a hex code. Leave empty to keep it.

Outputs

tagobject
The tag
Example output
{
  "tag": {
    "created_datetime": "2026-10-01T09:00:00",
    "decoration": {
      "color": "#F9A825"
    },
    "deleted_datetime": null,
    "description": "Refund requests",
    "id": 77,
    "name": "refunds",
    "uri": "/api/tags/77/",
    "usage": 4
  }
}

Update ticket

Change a ticket's subject, status, priority, assignee or snooze time. Fields left empty are kept as they are.

Inputs

Ticket IDticket_idtextRequired
The ticket's number, from 'List tickets' or 'Create ticket'.
Subjectsubjecttext
A new subject. Leave empty to keep it.
Statusstatustext
Open or close the ticket. Leave empty to keep it.One of: open, closed.
Priorityprioritytext
A new priority. Leave empty to keep it.One of: normal (Normal (default)), low, high, critical.
Assign to userassignee_user_idtext
The user who should own the ticket.
Assign to teamassignee_team_idtext
The team that should own the ticket.
Snooze untilsnooze_untildate and time
Hide the ticket until this time, when it reopens by itself.
Mark as spamspamtrue/false
Turn on to mark the ticket as spam. Leave off to keep it as is.

Outputs

ticketobject
The ticket
Example output
{
  "ticket": {
    "assignee_team": null,
    "assignee_user": null,
    "channel": "api",
    "closed_datetime": null,
    "created_datetime": "2026-10-15T09:00:00",
    "customer": {
      "email": "jo@example.com",
      "firstname": "Jo",
      "id": 3924,
      "name": "Jo Bloggs"
    },
    "external_id": null,
    "from_agent": false,
    "id": 123,
    "is_unread": true,
    "language": "en",
    "last_message_datetime": "2026-10-15T09:00:00",
    "last_received_message_datetime": "2026-10-15T09:00:00",
    "messages_count": 1,
    "opened_datetime": null,
    "priority": "normal",
    "snooze_datetime": null,
    "spam": false,
    "status": "closed",
    "subject": "Where is my order?",
    "tags": [
      {
        "created_datetime": "2026-10-01T09:00:00",
        "decoration": {
          "color": "#F9A825"
        },
        "deleted_datetime": null,
        "description": "Refund requests",
        "id": 77,
        "name": "refund",
        "uri": "/api/tags/77/",
        "usage": 4
      }
    ],
    "trashed_datetime": null,
    "updated_datetime": "2026-10-15T09:00:00",
    "uri": "/api/tickets/123/",
    "via": "api"
  }
}

On this page