← Tools Reference

Gorgias

Gorgias integration (Communication, Productivity). Imported from open-connector.

API key6 toolshttps://{domain}.gorgias.com
GET
gorgias_get_account
Retrieve the current Gorgias helpdesk account.

/api/account

GET
gorgias_list_users
List Gorgias users with documented filters and ordering.

/api/users

8 parameters
ParamTypeRequiredDescription
cursorstringoptionalA Gorgias cursor returned by a previous paginated response.
externalIdstringoptionalID of the user in a foreign system to filter by.
emailstringoptionalEmail address of the user to filter by.
limitintegeroptionalMaximum number of Gorgias records to return.
orderBystringoptionalAttribute and direction used to order Gorgias users.
rolesarrayoptionalGorgias roles used to filter users.
searchstringoptionalText used to search user names or email addresses.
availableFirstbooleanoptionalWhether available users should be returned before non-available users.
GET
gorgias_list_customers
List Gorgias customers with cursor pagination and lookup filters.

/api/customers

4 parameters
ParamTypeRequiredDescription
cursorstringoptionalA Gorgias cursor returned by a previous paginated response.
emailstringoptionalPrimary customer email address to filter by.
externalIdstringoptionalID of the customer in a foreign system to filter by.
limitintegeroptionalMaximum number of Gorgias records to return.
GET
gorgias_list_tickets
List Gorgias tickets with cursor pagination and common filters.

/api/tickets

9 parameters
ParamTypeRequiredDescription
cursorstringoptionalA Gorgias cursor returned by a previous paginated response.
customerIdintegeroptionalGorgias customer identifier used to filter tickets.
trashedbooleanoptionalWhether to include trashed tickets in the response.
externalIdstringoptionalID of the ticket in a foreign system to filter by.
limitintegeroptionalMaximum number of Gorgias records to return.
viewIdintegeroptionalGorgias view identifier used to select tickets.
ruleIdintegeroptionalGorgias rule identifier used to select tickets.
ticketIdsarrayoptionalSpecific Gorgias ticket identifiers to select.
orderBystringoptionalAttribute and direction used to order Gorgias tickets.
GET
gorgias_get_ticket
Retrieve one Gorgias ticket by identifier.

/api/tickets/{ticketId}

2 parameters
ParamTypeRequiredDescription
ticketIdintegerrequiredGorgias ticket identifier.
relationshipsarrayoptionalGorgias ticket relations to include in the returned ticket.
GET
gorgias_list_tags
List Gorgias tags with cursor pagination, search, and ordering.

/api/tags

4 parameters
ParamTypeRequiredDescription
cursorstringoptionalA Gorgias cursor returned by a previous paginated response.
searchstringoptionalText used to search tag names.
limitintegeroptionalMaximum number of Gorgias records to return.
orderBystringoptionalAttribute and direction used to order Gorgias tags.