> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Gorgias

> Gorgias is a helpdesk and live chat platform specializing in e-commerce, offering automated support, order management, and unified customer communication

![Gorgias logo](https://mintcdn.com/composio-preview/o1IUBrrsmtgkhmyf/images/toolkits/gorgias.svg?fit=max\&auto=format\&n=o1IUBrrsmtgkhmyf\&q=85\&s=02d66881b79f9c37566a2ab5d422542c)

* **Category:** crm
* **Auth:** API\_KEY, OAUTH2
* **Composio-managed OAuth available?** Yes
* **Tools:** 51
* **Triggers:** 0
* **Slug:** `GORGIAS`
* **Version:** 20261101\_00

## Tools

> [accordion] Add Ticket Tags
>
> **Slug:** `GORGIAS_ADD_TICKET_TAGS`
>
> Adds tags to a ticket in Gorgias.
>
> #### Input Parameters
>
> **tag\_ids** `array` *required*
>
> List of tag IDs to add to the ticket
>
> **ticket\_id** `integer` *required*
>
> The ID of the ticket
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Account Setting
>
> **Slug:** `GORGIAS_CREATE_ACCOUNT_SETTING`
>
> Creates a new account setting in Gorgias.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The name of the setting
>
> **value** `string` *required*
>
> The value of the setting
>
> **description** `string`
>
> Description of the setting
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Customer
>
> **Slug:** `GORGIAS_CREATE_CUSTOMER`
>
> Creates a new customer in Gorgias.
>
> #### Input Parameters
>
> **data** `object`
>
> Additional customer data
>
> **name** `string` *required*
>
> The customer's full name
>
> **email** `string`
>
> The customer's email address
>
> **address** `object`
>
> The customer's address information
>
> **channels** `array`
>
> The customer's communication channels
>
> **external\_id** `string`
>
> External identifier for the customer
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Macro
>
> **Slug:** `GORGIAS_CREATE_MACRO`
>
> Creates a reusable response macro and its ticket actions. Reference: [https://developers.gorgias.com/reference/create-macro](https://developers.gorgias.com/reference/create-macro)
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Searchable name of the macro
>
> **intent** `string ("discount/request" | "exchange/request" | "exchange/status" | "feedback" | "order/damaged" | "order/cancel" | "order/change" | "order/wrong" | "other/no_reply" | "other/question" | "other/thanks" | "product/recommendation" | "product/question" | "refund/request" | "refund/status" | "return/request" | "return/status" | "shipping/change" | "shipping/delivery-issue" | "shipping/policy" | "shipping/status" | "stock/request" | "subscription/cancel" | "subscription/change")`
>
> Documented support intent served by the macro
>
> **actions** `array`
>
> Actions to apply when the macro is used
>
> **language** `string`
>
> Macro language in ISO 639-1 format
>
> **external\_id** `string`
>
> ID of the macro in an external system
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Rule
>
> **Slug:** `GORGIAS_CREATE_RULE`
>
> Create a JavaScript automation rule in Gorgias.
>
> #### Input Parameters
>
> **code** `string` *required*
>
> Rule logic as JavaScript code
>
> **name** `string` *required*
>
> Name of the rule
>
> **code\_ast** `object`
>
> Rule logic as an ESTree AST; generated from code when omitted
>
> **priority** `integer`
>
> Execution order; rules with higher priorities execute first
>
> **description** `string`
>
> Description of the rule
>
> **event\_types** `array`
>
> Events that execute the rule
>
> **deactivated\_datetime** `string`
>
> When the rule was deactivated
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Tag
>
> **Slug:** `GORGIAS_CREATE_TAG`
>
> Creates a workspace tag for organizing tickets. Reference: [https://developers.gorgias.com/reference/create-tag](https://developers.gorgias.com/reference/create-tag)
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Case-sensitive name of the workspace tag
>
> **decoration** `object`
>
> Tag display styling
>
> **description** `string`
>
> Short description of the workspace tag
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Team
>
> **Slug:** `GORGIAS_CREATE_TEAM`
>
> Creates a new team in Gorgias.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the team
>
> **members** `array`
>
> The list of users within the team
>
> **decoration** `object`
>
> Object describing how the team appears on the webpage
>
> **description** `string`
>
> Longer description of the team
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Ticket
>
> **Slug:** `GORGIAS_CREATE_TICKET`
>
> Creates a new ticket in Gorgias.
>
> #### Input Parameters
>
> **via** `string` *required*
>
> How the first message of the ticket has been received or sent from Gorgias
>
> **meta** `object`
>
> Extra metadata about the ticket
>
> **tags** `array`
>
> List of tag IDs to apply to the ticket
>
> **status** `string`
>
> The status of the ticket
>
> **channel** `string`
>
> The channel of the ticket (email, chat, etc.)
>
> **subject** `string`
>
> The subject of the ticket
>
> **customer** `object`
>
> Customer information (id, name, or email)
>
> **language** `string`
>
> The language of the ticket
>
> **messages** `array` *required*
>
> Messages of the ticket
>
> **priority** `string`
>
> The priority of the ticket
>
> **external\_id** `string`
>
> External identifier for the ticket
>
> **assignee\_team\_id** `integer`
>
> ID of the team to assign the ticket to
>
> **assignee\_user\_id** `integer`
>
> ID of the user to assign the ticket to
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create View
>
> **Slug:** `GORGIAS_CREATE_VIEW`
>
> Create a saved ticket-list view in Gorgias.
>
> #### Input Parameters
>
> **name** `string`
>
> Name of the view
>
> **slug** `string` *required*
>
> Deprecated but required URL-compatible name of the view
>
> **type** `string ("ticket-list")`
>
> Type of objects to which the view applies
>
> **fields** `array`
>
> Object attributes displayed in the view
>
> **filters** `string`
>
> JavaScript filter expression selecting items for the view
>
> **order\_by** `string`
>
> Object attribute used to sort view items
>
> **order\_dir** `string ("asc" | "desc")`
>
> Sort direction for view items
>
> **decoration** `object`
>
> How the view appears in Gorgias applications
>
> **visibility** `string ("public" | "shared" | "private")`
>
> Who can see the view
>
> **shared\_with\_teams** `array`
>
> IDs of teams this view is shared with (maximum 100)
>
> **shared\_with\_users** `array`
>
> IDs of users this view is shared with (maximum 100)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Customer
>
> **Slug:** `GORGIAS_DELETE_CUSTOMER`
>
> Deletes a specific customer from Gorgias.
>
> #### Input Parameters
>
> **customer\_id** `integer` *required*
>
> The ID of the customer to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Customer Field Value
>
> **Slug:** `GORGIAS_DELETE_CUSTOMER_FIELD_VALUE`
>
> Deletes a specific field value for a customer in Gorgias.
>
> #### Input Parameters
>
> **field\_id** `integer` *required*
>
> The ID of the custom field
>
> **customer\_id** `integer` *required*
>
> The ID of the customer
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Customers
>
> **Slug:** `GORGIAS_DELETE_CUSTOMERS`
>
> Deletes multiple customers from Gorgias.
>
> #### Input Parameters
>
> **customer\_ids** `array` *required*
>
> List of customer IDs to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Team
>
> **Slug:** `GORGIAS_DELETE_TEAM`
>
> Deletes a specific team from Gorgias.
>
> #### Input Parameters
>
> **team\_id** `integer` *required*
>
> The ID of the team to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Ticket
>
> **Slug:** `GORGIAS_DELETE_TICKET`
>
> Deletes a specific ticket from Gorgias.
>
> #### Input Parameters
>
> **ticket\_id** `integer` *required*
>
> The ID of the ticket to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Ticket Field Value
>
> **Slug:** `GORGIAS_DELETE_TICKET_FIELD_VALUE`
>
> Deletes a specific custom field value from a Gorgias ticket. System-managed fields can only be deleted by Gorgias internal apps.
>
> #### Input Parameters
>
> **field\_id** `integer` *required*
>
> The ID of the custom field
>
> **ticket\_id** `integer` *required*
>
> The ID of the ticket
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Account
>
> **Slug:** `GORGIAS_GET_ACCOUNT`
>
> Retrieves your Gorgias account information.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Customer
>
> **Slug:** `GORGIAS_GET_CUSTOMER`
>
> Retrieves a specific customer from Gorgias.
>
> #### Input Parameters
>
> **customer\_id** `integer` *required*
>
> The ID of the customer to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Event
>
> **Slug:** `GORGIAS_GET_EVENT`
>
> Retrieves a specific event from Gorgias.
>
> #### Input Parameters
>
> **event\_id** `integer` *required*
>
> The ID of the event to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Macro
>
> **Slug:** `GORGIAS_GET_MACRO`
>
> Retrieves one reusable Gorgias macro by ID. Reference: [https://developers.gorgias.com/reference/get-macro](https://developers.gorgias.com/reference/get-macro)
>
> #### Input Parameters
>
> **macro\_id** `integer` *required*
>
> ID of the macro to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Rule
>
> **Slug:** `GORGIAS_GET_RULE`
>
> Retrieves one Gorgias automation rule by ID. Reference: [https://developers.gorgias.com/reference/get-rule](https://developers.gorgias.com/reference/get-rule)
>
> #### Input Parameters
>
> **rule\_id** `integer` *required*
>
> ID of the automation rule to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Team
>
> **Slug:** `GORGIAS_GET_TEAM`
>
> Retrieves a specific team from Gorgias.
>
> #### Input Parameters
>
> **team\_id** `integer` *required*
>
> The ID of the team to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Ticket
>
> **Slug:** `GORGIAS_GET_TICKET`
>
> Retrieves a specific ticket from Gorgias.
>
> #### Input Parameters
>
> **ticket\_id** `integer` *required*
>
> The ID of the ticket to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Ticket Message
>
> **Slug:** `GORGIAS_GET_TICKET_MESSAGE`
>
> Retrieves one message from a Gorgias ticket. Reference: [https://developers.gorgias.com/reference/get-ticket-message](https://developers.gorgias.com/reference/get-ticket-message)
>
> #### Input Parameters
>
> **ticket\_id** `integer` *required*
>
> ID of the ticket containing the message
>
> **message\_id** `integer` *required*
>
> ID of the message to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Account Settings
>
> **Slug:** `GORGIAS_LIST_ACCOUNT_SETTINGS`
>
> Lists account settings in Gorgias with pagination.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of settings to return (default: 20, max: 100)
>
> **offset** `integer`
>
> Offset for pagination
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Customer Field Values
>
> **Slug:** `GORGIAS_LIST_CUSTOMER_FIELD_VALUES`
>
> Lists all custom field values for a customer in Gorgias.
>
> #### Input Parameters
>
> **customer\_id** `integer` *required*
>
> The ID of the customer
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Customers
>
> **Slug:** `GORGIAS_LIST_CUSTOMERS`
>
> Lists customers in Gorgias with various filtering options.
>
> #### Input Parameters
>
> **name** `string`
>
> Filter customers by name
>
> **email** `string`
>
> Filter customers by email address
>
> **limit** `integer`
>
> Number of customers to return per page (1-100, default: 30)
>
> **cursor** `string`
>
> Pagination cursor from meta.next\_cursor of previous response
>
> **order\_by** `string`
>
> Field to order results by. Note: Valid values must be discovered via API testing. Common values like 'created\_datetime' may not be accepted.
>
> **external\_id** `string`
>
> Filter customers by external ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Events
>
> **Slug:** `GORGIAS_LIST_EVENTS`
>
> Lists events in Gorgias. Returns event objects with pagination support via cursor. Reference: [https://developers.gorgias.com/reference/get\_api-events](https://developers.gorgias.com/reference/get_api-events)
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of events to return (max: 100)
>
> **types** `array`
>
> Array of event types to filter by (e.g., \['ticket-created', 'user-logged-in'])
>
> **cursor** `string`
>
> Pagination cursor from meta.next\_cursor
>
> **object\_id** `integer`
>
> Filter by object ID
>
> **object\_type** `string`
>
> Filter by object type (e.g., 'Ticket', 'Account', 'User')
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Integrations
>
> **Slug:** `GORGIAS_LIST_INTEGRATIONS`
>
> Lists Gorgias integrations, optionally filtered by integration type. Reference: [https://developers.gorgias.com/reference/list-integrations](https://developers.gorgias.com/reference/list-integrations)
>
> #### Input Parameters
>
> **type** `string ("email" | "gmail" | "outlook" | "app" | "aircall" | "facebook" | "gorgias_chat" | "phone" | "sms" | "twitter" | "yotpo" | "whatsapp" | "http" | "shopify" | "recharge" | "smile" | "smooch_inside" | "smooch" | "magento2" | "zendesk" | "klaviyo" | "bigcommerce" | "alloy" | "ecom")`
>
> Filter by the exact Gorgias integration type
>
> **limit** `integer`
>
> Maximum number of integrations to return (1-100)
>
> **cursor** `string`
>
> Pagination cursor from meta.next\_cursor or meta.prev\_cursor
>
> **order\_by** `string ("created_datetime:asc" | "created_datetime:desc")`
>
> Order integrations by creation time
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Macros
>
> **Slug:** `GORGIAS_LIST_MACROS`
>
> Lists and filters reusable macros with cursor pagination. Reference: [https://developers.gorgias.com/reference/list-macros](https://developers.gorgias.com/reference/list-macros)
>
> #### Input Parameters
>
> **tags** `array`
>
> Filter macros by tag names
>
> **limit** `integer`
>
> Maximum number of macros to return (1-100)
>
> **cursor** `string`
>
> Pagination cursor from meta.next\_cursor or meta.prev\_cursor
>
> **search** `string`
>
> Filter macros containing this search text
>
> **archived** `boolean`
>
> Return only archived macros when true
>
> **order\_by** `string ("name" | "created_datetime" | "updated_datetime" | "usage" | "relevance" | "language" | "name:asc" | "name:desc" | "created_datetime:asc" | "created_datetime:desc" | "updated_datetime:asc" | "updated_datetime:desc" | "usage:asc" | "usage:desc" | "relevance:asc" | "relevance:desc" | "language:asc" | "language:desc")`
>
> Attribute and direction used to order macros
>
> **languages** `array`
>
> Filter macros by language codes
>
> **ticket\_id** `integer`
>
> Ticket used to rank relevant macros
>
> **message\_id** `integer`
>
> Message used to rank relevant macros
>
> **number\_predictions** `integer`
>
> Number of relevant macros to place at the top of the list
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Messages
>
> **Slug:** `GORGIAS_LIST_MESSAGES`
>
> Lists messages in Gorgias, optionally filtered by ticket. Reference: [https://developers.gorgias.com/reference/list-messages](https://developers.gorgias.com/reference/list-messages)
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of messages to return (1-100)
>
> **cursor** `string`
>
> Pagination cursor from meta.next\_cursor or meta.prev\_cursor
>
> **order\_by** `string ("created_datetime:asc" | "created_datetime:desc")`
>
> Order messages by creation time
>
> **ticket\_id** `integer`
>
> Filter messages by the associated ticket ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Rules
>
> **Slug:** `GORGIAS_LIST_RULES`
>
> Lists automation rules with optional name search. Reference: [https://developers.gorgias.com/reference/list-rules](https://developers.gorgias.com/reference/list-rules)
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of rules to return (1-100)
>
> **cursor** `string`
>
> Pagination cursor from a previous list-rules request
>
> **search** `string`
>
> Case-insensitive search by rule name
>
> **order\_by** `string ("created_datetime:asc" | "created_datetime:desc")`
>
> Attribute and direction used to order rules
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Tags
>
> **Slug:** `GORGIAS_LIST_TAGS`
>
> Lists workspace tags independently of any ticket. Reference: [https://developers.gorgias.com/reference/list-tags](https://developers.gorgias.com/reference/list-tags)
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of tags to return (1-100)
>
> **cursor** `string`
>
> Pagination cursor from meta.next\_cursor or meta.prev\_cursor
>
> **search** `string`
>
> Match tag names containing this text, case-insensitively
>
> **order\_by** `string ("created_datetime:asc" | "created_datetime:desc" | "name:asc" | "name:desc" | "usage:asc,name:asc" | "usage:desc,name:desc")`
>
> Attribute and direction used to order tags
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Teams
>
> **Slug:** `GORGIAS_LIST_TEAMS`
>
> Lists teams in Gorgias.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of teams to return per page (default: 20, max: 100).
>
> **cursor** `string`
>
> Cursor for pagination. Use the value of 'meta.next\_cursor' from a previous response to fetch the next page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Ticket Field Values
>
> **Slug:** `GORGIAS_LIST_TICKET_FIELD_VALUES`
>
> Lists all field values for a ticket in Gorgias.
>
> #### Input Parameters
>
> **ticket\_id** `integer` *required*
>
> The ID of the ticket
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Tickets
>
> **Slug:** `GORGIAS_LIST_TICKETS`
>
> Lists tickets in Gorgias with various filtering options.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of tickets to return
>
> **cursor** `string`
>
> Cursor value indicating position in the list of all tickets for pagination. Use next\_cursor or prev\_cursor from previous response.
>
> **rule\_id** `integer`
>
> Apply filters from a rule to ticket selection
>
> **trashed** `boolean`
>
> Whether to include removed tickets in results
>
> **view\_id** `integer`
>
> Apply filters from a predefined view to ticket selection
>
> **order\_by** `string ("created_datetime:asc" | "created_datetime:desc" | "updated_datetime:asc" | "updated_datetime:desc")`
>
> Sort order for tickets
>
> **ticket\_ids** `array`
>
> Select specific tickets by their identifiers (1-100 IDs)
>
> **customer\_id** `integer`
>
> Filter tickets by customer ID
>
> **external\_id** `string`
>
> Identifier from external systems for ticket lookup
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Ticket Tags
>
> **Slug:** `GORGIAS_LIST_TICKET_TAGS`
>
> Lists all tags for a ticket in Gorgias.
>
> #### Input Parameters
>
> **ticket\_id** `integer` *required*
>
> The ID of the ticket
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Users
>
> **Slug:** `GORGIAS_LIST_USERS`
>
> Lists helpdesk users with optional role and identity filters. Reference: [https://developers.gorgias.com/reference/list-users](https://developers.gorgias.com/reference/list-users)
>
> #### Input Parameters
>
> **email** `string`
>
> Filter users by email address
>
> **limit** `integer`
>
> Maximum number of users to return (1-100)
>
> **roles** `array`
>
> Roles to include in the results
>
> **cursor** `string`
>
> Pagination cursor from a previous list-users request
>
> **search** `string`
>
> Match users by name or email address
>
> **order\_by** `string ("created_datetime:asc" | "created_datetime:desc" | "name:asc" | "name:desc" | "email:asc" | "email:desc" | "role.name:asc" | "role.name:desc")`
>
> Attribute and direction used to order users
>
> **external\_id** `string`
>
> Filter users by their external-system ID
>
> **available\_first** `boolean`
>
> Return available users before non-available users
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List View Items
>
> **Slug:** `GORGIAS_LIST_VIEW_ITEMS`
>
> Lists tickets matching a saved Gorgias view. Reference: [https://developers.gorgias.com/reference/list-view-items](https://developers.gorgias.com/reference/list-view-items)
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of view items to return (1-100)
>
> **cursor** `string`
>
> Pagination cursor from the current\_cursor value or an item link
>
> **view\_id** `integer` *required*
>
> ID of the view whose items to list
>
> **order\_by** `string ("created_datetime:asc" | "created_datetime:desc" | "updated_datetime:asc" | "updated_datetime:desc" | "last_message_datetime:asc" | "last_message_datetime:desc" | "last_received_message_datetime:asc" | "last_received_message_datetime:desc" | "closed_datetime:asc" | "closed_datetime:desc" | "snooze_datetime:asc" | "snooze_datetime:desc" | "priority:asc" | "priority:desc")`
>
> Ticket attribute and direction used to order the view items
>
> **direction** `string ("prev" | "next")`
>
> Return items before (prev) or after (next) the cursor
>
> **ignored\_item** `integer`
>
> ID of an item to omit from the returned page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Views
>
> **Slug:** `GORGIAS_LIST_VIEWS`
>
> Lists saved ticket views, optionally filtered by category. Reference: [https://developers.gorgias.com/reference/list-views](https://developers.gorgias.com/reference/list-views)
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of views to return (1-100)
>
> **cursor** `string`
>
> Pagination cursor from meta.next\_cursor or meta.prev\_cursor
>
> **category** `string ("system" | "user")`
>
> Filter views by system-managed or user-created category
>
> **order\_by** `string ("created_datetime:asc" | "created_datetime:desc")`
>
> Order views by creation time
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Merge Customers
>
> **Slug:** `GORGIAS_MERGE_CUSTOMERS`
>
> Merges a source customer into a target customer in Gorgias, combining their data and deleting the source customer.
>
> #### Input Parameters
>
> **source\_customer\_id** `integer` *required*
>
> The ID of the source customer (will be merged into the target)
>
> **target\_customer\_id** `integer` *required*
>
> The ID of the target customer (will remain after merge)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Query Reporting Statistics
>
> **Slug:** `GORGIAS_QUERY_REPORTING_STATISTICS`
>
> Queries metric-specific reporting statistics. Reference: [https://developers.gorgias.com/reference/get-statistic](https://developers.gorgias.com/reference/get-statistic)
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of reporting rows to return (1-10000)
>
> **query** `object` *required*
>
> Reporting query whose supported members depend on its scope
>
> **cursor** `string`
>
> Pagination cursor from meta.next\_cursor or meta.prev\_cursor
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Ticket Tags
>
> **Slug:** `GORGIAS_REMOVE_TICKET_TAGS`
>
> Removes tags from a ticket in Gorgias.
>
> #### Input Parameters
>
> **tag\_ids** `array` *required*
>
> List of tag IDs to remove from the ticket
>
> **ticket\_id** `integer` *required*
>
> The ID of the ticket
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Ticket Message
>
> **Slug:** `GORGIAS_SEND_TICKET_MESSAGE`
>
> Sends an externally delivered message on an existing Gorgias ticket. Delivery happens asynchronously after creation; internal notes are not supported. References: [https://developers.gorgias.com/reference/create-ticket-message](https://developers.gorgias.com/reference/create-ticket-message) [https://developers.gorgias.com/docs/create-a-new-message-in-ticket-via-api](https://developers.gorgias.com/docs/create-a-new-message-in-ticket-via-api)
>
> #### Input Parameters
>
> **sender** `object`
>
> Customer or user sending the message
>
> **source** `object`
>
> External routing details; email source.from.address must match an existing Gorgias email integration
>
> **channel** `string` *required*
>
> External delivery channel, such as email; internal notes are not supported
>
> **subject** `string`
>
> Message subject
>
> **receiver** `object`
>
> Primary customer or user receiving the message
>
> **body\_html** `string`
>
> HTML message body
>
> **body\_text** `string`
>
> Plain-text message body
>
> **ticket\_id** `integer` *required*
>
> ID of the ticket receiving the message
>
> **attachments** `array`
>
> Files to attach to the message
>
> **external\_id** `string`
>
> Caller-defined external message ID
>
> **integration\_id** `integer`
>
> ID of the integration used to send the message
>
> **if\_unmodified\_since** `string`
>
> HTTP date used to detect whether the source ticket was merged after that time
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Customer Data
>
> **Slug:** `GORGIAS_SET_CUSTOMER_DATA`
>
> Sets the complete data object for a customer in Gorgias.
>
> #### Input Parameters
>
> **data** `object` *required*
>
> The complete data object to set for the customer
>
> **customer\_id** `integer` *required*
>
> The ID of the customer
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Ticket Tags
>
> **Slug:** `GORGIAS_SET_TICKET_TAGS`
>
> Sets the complete list of tags for a ticket in Gorgias.
>
> #### Input Parameters
>
> **tag\_ids** `array` *required*
>
> List of tag IDs to set for the ticket
>
> **ticket\_id** `integer` *required*
>
> The ID of the ticket
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Account Setting
>
> **Slug:** `GORGIAS_UPDATE_ACCOUNT_SETTING`
>
> Updates an existing account setting in Gorgias.
>
> #### Input Parameters
>
> **value** `string` *required*
>
> The new value of the setting
>
> **setting\_id** `integer` *required*
>
> The ID of the setting to update
>
> **description** `string`
>
> Updated description of the setting
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Customer
>
> **Slug:** `GORGIAS_UPDATE_CUSTOMER`
>
> Updates an existing customer in Gorgias.
>
> #### Input Parameters
>
> **data** `object`
>
> Additional customer data
>
> **name** `string`
>
> The customer's full name
>
> **email** `string`
>
> The customer's email address
>
> **address** `object`
>
> The customer's address information
>
> **channels** `array`
>
> The customer's communication channels
>
> **customer\_id** `integer` *required*
>
> The ID of the customer to update
>
> **external\_id** `string`
>
> External identifier for the customer
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Macro
>
> **Slug:** `GORGIAS_UPDATE_MACRO`
>
> Updates the reusable content or metadata of a macro. Reference: [https://developers.gorgias.com/reference/update-macro](https://developers.gorgias.com/reference/update-macro)
>
> #### Input Parameters
>
> **name** `string`
>
> Searchable name of the macro
>
> **intent** `string ("discount/request" | "exchange/request" | "exchange/status" | "feedback" | "order/damaged" | "order/cancel" | "order/change" | "order/wrong" | "other/no_reply" | "other/question" | "other/thanks" | "product/recommendation" | "product/question" | "refund/request" | "refund/status" | "return/request" | "return/status" | "shipping/change" | "shipping/delivery-issue" | "shipping/policy" | "shipping/status" | "stock/request" | "subscription/cancel" | "subscription/change")`
>
> Documented support intent served by the macro
>
> **actions** `array`
>
> Actions to apply when the macro is used
>
> **language** `string`
>
> Macro language in ISO 639-1 format
>
> **macro\_id** `integer` *required*
>
> ID of the macro to update
>
> **external\_id** `string`
>
> ID of the macro in an external system
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Tag
>
> **Slug:** `GORGIAS_UPDATE_TAG`
>
> Updates a workspace tag's name, description, or color. Reference: [https://developers.gorgias.com/reference/update-tag](https://developers.gorgias.com/reference/update-tag)
>
> #### Input Parameters
>
> **name** `string`
>
> New case-sensitive tag name
>
> **tag\_id** `integer` *required*
>
> ID of the workspace tag to update
>
> **decoration** `object`
>
> New tag display styling
>
> **description** `string`
>
> New tag description
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Team
>
> **Slug:** `GORGIAS_UPDATE_TEAM`
>
> Updates an existing team in Gorgias.
>
> #### Input Parameters
>
> **name** `string`
>
> Name of the team
>
> **members** `array`
>
> The list of users within the team
>
> **team\_id** `integer` *required*
>
> The ID of the team to update
>
> **decoration** `object`
>
> Object describing how the team appears on the webpage
>
> **description** `string`
>
> Longer description of the team
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Ticket
>
> **Slug:** `GORGIAS_UPDATE_TICKET`
>
> Updates an existing ticket in Gorgias.
>
> #### Input Parameters
>
> **meta** `object`
>
> Extra metadata about the ticket
>
> **status** `string`
>
> The status of the ticket
>
> **subject** `string`
>
> The subject of the ticket
>
> **language** `string`
>
> The language of the ticket
>
> **priority** `string`
>
> The priority of the ticket
>
> **ticket\_id** `integer` *required*
>
> The ID of the ticket to update
>
> **customer\_id** `integer`
>
> The ID of the customer for this ticket
>
> **external\_id** `string`
>
> External identifier for the ticket
>
> **assignee\_team\_id** `integer`
>
> ID of the team to assign the ticket to
>
> **assignee\_user\_id** `integer`
>
> ID of the user to assign the ticket to
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
