Skip to main content
Gorgias logo
  • Category: crm
  • Auth: API_KEY, OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 51
  • Triggers: 0
  • Slug: GORGIAS
  • Version: 20261101_00

Tools

Slug: GORGIAS_ADD_TICKET_TAGSAdds tags to a ticket in Gorgias.

Input Parameters

array
required
List of tag IDs to add to the ticket
integer
required
The ID of the ticket

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_CREATE_ACCOUNT_SETTINGCreates a new account setting in Gorgias.

Input Parameters

string
required
The name of the setting
string
required
The value of the setting
string
Description of the setting

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_CREATE_CUSTOMERCreates a new customer in Gorgias.

Input Parameters

object
Additional customer data
string
required
The customer’s full name
string
The customer’s email address
object
The customer’s address information
array
The customer’s communication channels
string
External identifier for the customer

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_CREATE_MACROCreates a reusable response macro and its ticket actions. Reference: https://developers.gorgias.com/reference/create-macro

Input Parameters

string
required
Searchable name of the macro
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
array
Actions to apply when the macro is used
string
Macro language in ISO 639-1 format
string
ID of the macro in an external system

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_CREATE_RULECreate a JavaScript automation rule in Gorgias.

Input Parameters

string
required
Rule logic as JavaScript code
string
required
Name of the rule
object
Rule logic as an ESTree AST; generated from code when omitted
integer
Execution order; rules with higher priorities execute first
string
Description of the rule
array
Events that execute the rule
string
When the rule was deactivated

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_CREATE_TAGCreates a workspace tag for organizing tickets. Reference: https://developers.gorgias.com/reference/create-tag

Input Parameters

string
required
Case-sensitive name of the workspace tag
object
Tag display styling
string
Short description of the workspace tag

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_CREATE_TEAMCreates a new team in Gorgias.

Input Parameters

string
required
Name of the team
array
The list of users within the team
object
Object describing how the team appears on the webpage
string
Longer description of the team

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_CREATE_TICKETCreates a new ticket in Gorgias.

Input Parameters

string
required
How the first message of the ticket has been received or sent from Gorgias
object
Extra metadata about the ticket
array
List of tag IDs to apply to the ticket
string
The status of the ticket
string
The channel of the ticket (email, chat, etc.)
string
The subject of the ticket
object
Customer information (id, name, or email)
string
The language of the ticket
array
required
Messages of the ticket
string
The priority of the ticket
string
External identifier for the ticket
integer
ID of the team to assign the ticket to
integer
ID of the user to assign the ticket to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_CREATE_VIEWCreate a saved ticket-list view in Gorgias.

Input Parameters

string
Name of the view
string
required
Deprecated but required URL-compatible name of the view
string ("ticket-list")
Type of objects to which the view applies
array
Object attributes displayed in the view
string
JavaScript filter expression selecting items for the view
string
Object attribute used to sort view items
string ("asc" | "desc")
Sort direction for view items
object
How the view appears in Gorgias applications
string ("public" | "shared" | "private")
Who can see the view
array
IDs of teams this view is shared with (maximum 100)
array
IDs of users this view is shared with (maximum 100)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_DELETE_CUSTOMERDeletes a specific customer from Gorgias.

Input Parameters

integer
required
The ID of the customer to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_DELETE_CUSTOMER_FIELD_VALUEDeletes a specific field value for a customer in Gorgias.

Input Parameters

integer
required
The ID of the custom field
integer
required
The ID of the customer

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_DELETE_CUSTOMERSDeletes multiple customers from Gorgias.

Input Parameters

array
required
List of customer IDs to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_DELETE_TEAMDeletes a specific team from Gorgias.

Input Parameters

integer
required
The ID of the team to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_DELETE_TICKETDeletes a specific ticket from Gorgias.

Input Parameters

integer
required
The ID of the ticket to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_DELETE_TICKET_FIELD_VALUEDeletes a specific custom field value from a Gorgias ticket. System-managed fields can only be deleted by Gorgias internal apps.

Input Parameters

integer
required
The ID of the custom field
integer
required
The ID of the ticket

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_GET_ACCOUNTRetrieves your Gorgias account information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_GET_CUSTOMERRetrieves a specific customer from Gorgias.

Input Parameters

integer
required
The ID of the customer to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_GET_EVENTRetrieves a specific event from Gorgias.

Input Parameters

integer
required
The ID of the event to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_GET_MACRORetrieves one reusable Gorgias macro by ID. Reference: https://developers.gorgias.com/reference/get-macro

Input Parameters

integer
required
ID of the macro to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_GET_RULERetrieves one Gorgias automation rule by ID. Reference: https://developers.gorgias.com/reference/get-rule

Input Parameters

integer
required
ID of the automation rule to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_GET_TEAMRetrieves a specific team from Gorgias.

Input Parameters

integer
required
The ID of the team to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_GET_TICKETRetrieves a specific ticket from Gorgias.

Input Parameters

integer
required
The ID of the ticket to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_GET_TICKET_MESSAGERetrieves one message from a Gorgias ticket. Reference: https://developers.gorgias.com/reference/get-ticket-message

Input Parameters

integer
required
ID of the ticket containing the message
integer
required
ID of the message to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_LIST_ACCOUNT_SETTINGSLists account settings in Gorgias with pagination.

Input Parameters

integer
Number of settings to return (default: 20, max: 100)
integer
Offset for pagination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_LIST_CUSTOMER_FIELD_VALUESLists all custom field values for a customer in Gorgias.

Input Parameters

integer
required
The ID of the customer

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_LIST_CUSTOMERSLists customers in Gorgias with various filtering options.

Input Parameters

string
Filter customers by name
string
Filter customers by email address
integer
Number of customers to return per page (1-100, default: 30)
string
Pagination cursor from meta.next_cursor of previous response
string
Field to order results by. Note: Valid values must be discovered via API testing. Common values like ‘created_datetime’ may not be accepted.
string
Filter customers by external ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_LIST_EVENTSLists events in Gorgias. Returns event objects with pagination support via cursor. Reference: https://developers.gorgias.com/reference/get_api-events

Input Parameters

integer
Number of events to return (max: 100)
array
Array of event types to filter by (e.g., [‘ticket-created’, ‘user-logged-in’])
string
Pagination cursor from meta.next_cursor
integer
Filter by object ID
string
Filter by object type (e.g., ‘Ticket’, ‘Account’, ‘User’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_LIST_INTEGRATIONSLists Gorgias integrations, optionally filtered by integration type. Reference: https://developers.gorgias.com/reference/list-integrations

Input Parameters

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
integer
Maximum number of integrations to return (1-100)
string
Pagination cursor from meta.next_cursor or meta.prev_cursor
string ("created_datetime:asc" | "created_datetime:desc")
Order integrations by creation time

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_LIST_MACROSLists and filters reusable macros with cursor pagination. Reference: https://developers.gorgias.com/reference/list-macros

Input Parameters

array
Filter macros by tag names
integer
Maximum number of macros to return (1-100)
string
Pagination cursor from meta.next_cursor or meta.prev_cursor
Filter macros containing this search text
boolean
Return only archived macros when true
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
array
Filter macros by language codes
integer
Ticket used to rank relevant macros
integer
Message used to rank relevant macros
integer
Number of relevant macros to place at the top of the list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_LIST_MESSAGESLists messages in Gorgias, optionally filtered by ticket. Reference: https://developers.gorgias.com/reference/list-messages

Input Parameters

integer
Maximum number of messages to return (1-100)
string
Pagination cursor from meta.next_cursor or meta.prev_cursor
string ("created_datetime:asc" | "created_datetime:desc")
Order messages by creation time
integer
Filter messages by the associated ticket ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_LIST_RULESLists automation rules with optional name search. Reference: https://developers.gorgias.com/reference/list-rules

Input Parameters

integer
Maximum number of rules to return (1-100)
string
Pagination cursor from a previous list-rules request
string
Case-insensitive search by rule name
string ("created_datetime:asc" | "created_datetime:desc")
Attribute and direction used to order rules

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_LIST_TAGSLists workspace tags independently of any ticket. Reference: https://developers.gorgias.com/reference/list-tags

Input Parameters

integer
Maximum number of tags to return (1-100)
string
Pagination cursor from meta.next_cursor or meta.prev_cursor
string
Match tag names containing this text, case-insensitively
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_LIST_TEAMSLists teams in Gorgias.

Input Parameters

integer
Maximum number of teams to return per page (default: 20, max: 100).
string
Cursor for pagination. Use the value of ‘meta.next_cursor’ from a previous response to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_LIST_TICKET_FIELD_VALUESLists all field values for a ticket in Gorgias.

Input Parameters

integer
required
The ID of the ticket

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_LIST_TICKETSLists tickets in Gorgias with various filtering options.

Input Parameters

integer
Maximum number of tickets to return
string
Cursor value indicating position in the list of all tickets for pagination. Use next_cursor or prev_cursor from previous response.
integer
Apply filters from a rule to ticket selection
boolean
Whether to include removed tickets in results
integer
Apply filters from a predefined view to ticket selection
string ("created_datetime:asc" | "created_datetime:desc" | "updated_datetime:asc" | "updated_datetime:desc")
Sort order for tickets
array
Select specific tickets by their identifiers (1-100 IDs)
integer
Filter tickets by customer ID
string
Identifier from external systems for ticket lookup

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_LIST_TICKET_TAGSLists all tags for a ticket in Gorgias.

Input Parameters

integer
required
The ID of the ticket

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_LIST_USERSLists helpdesk users with optional role and identity filters. Reference: https://developers.gorgias.com/reference/list-users

Input Parameters

string
Filter users by email address
integer
Maximum number of users to return (1-100)
array
Roles to include in the results
string
Pagination cursor from a previous list-users request
string
Match users by name or email address
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
string
Filter users by their external-system ID
boolean
Return available users before non-available users

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_LIST_VIEW_ITEMSLists tickets matching a saved Gorgias view. Reference: https://developers.gorgias.com/reference/list-view-items

Input Parameters

integer
Maximum number of view items to return (1-100)
string
Pagination cursor from the current_cursor value or an item link
integer
required
ID of the view whose items to list
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
string ("prev" | "next")
Return items before (prev) or after (next) the cursor
integer
ID of an item to omit from the returned page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_LIST_VIEWSLists saved ticket views, optionally filtered by category. Reference: https://developers.gorgias.com/reference/list-views

Input Parameters

integer
Maximum number of views to return (1-100)
string
Pagination cursor from meta.next_cursor or meta.prev_cursor
string ("system" | "user")
Filter views by system-managed or user-created category
string ("created_datetime:asc" | "created_datetime:desc")
Order views by creation time

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_MERGE_CUSTOMERSMerges a source customer into a target customer in Gorgias, combining their data and deleting the source customer.

Input Parameters

integer
required
The ID of the source customer (will be merged into the target)
integer
required
The ID of the target customer (will remain after merge)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_QUERY_REPORTING_STATISTICSQueries metric-specific reporting statistics. Reference: https://developers.gorgias.com/reference/get-statistic

Input Parameters

integer
Maximum number of reporting rows to return (1-10000)
object
required
Reporting query whose supported members depend on its scope
string
Pagination cursor from meta.next_cursor or meta.prev_cursor

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_REMOVE_TICKET_TAGSRemoves tags from a ticket in Gorgias.

Input Parameters

array
required
List of tag IDs to remove from the ticket
integer
required
The ID of the ticket

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_SEND_TICKET_MESSAGESends 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/docs/create-a-new-message-in-ticket-via-api

Input Parameters

object
Customer or user sending the message
object
External routing details; email source.from.address must match an existing Gorgias email integration
string
required
External delivery channel, such as email; internal notes are not supported
string
Message subject
object
Primary customer or user receiving the message
string
HTML message body
string
Plain-text message body
integer
required
ID of the ticket receiving the message
array
Files to attach to the message
string
Caller-defined external message ID
integer
ID of the integration used to send the message
string
HTTP date used to detect whether the source ticket was merged after that time

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_SET_CUSTOMER_DATASets the complete data object for a customer in Gorgias.

Input Parameters

object
required
The complete data object to set for the customer
integer
required
The ID of the customer

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_SET_TICKET_TAGSSets the complete list of tags for a ticket in Gorgias.

Input Parameters

array
required
List of tag IDs to set for the ticket
integer
required
The ID of the ticket

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_UPDATE_ACCOUNT_SETTINGUpdates an existing account setting in Gorgias.

Input Parameters

string
required
The new value of the setting
integer
required
The ID of the setting to update
string
Updated description of the setting

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_UPDATE_CUSTOMERUpdates an existing customer in Gorgias.

Input Parameters

object
Additional customer data
string
The customer’s full name
string
The customer’s email address
object
The customer’s address information
array
The customer’s communication channels
integer
required
The ID of the customer to update
string
External identifier for the customer

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_UPDATE_MACROUpdates the reusable content or metadata of a macro. Reference: https://developers.gorgias.com/reference/update-macro

Input Parameters

string
Searchable name of the macro
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
array
Actions to apply when the macro is used
string
Macro language in ISO 639-1 format
integer
required
ID of the macro to update
string
ID of the macro in an external system

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_UPDATE_TAGUpdates a workspace tag’s name, description, or color. Reference: https://developers.gorgias.com/reference/update-tag

Input Parameters

string
New case-sensitive tag name
integer
required
ID of the workspace tag to update
object
New tag display styling
string
New tag description

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_UPDATE_TEAMUpdates an existing team in Gorgias.

Input Parameters

string
Name of the team
array
The list of users within the team
integer
required
The ID of the team to update
object
Object describing how the team appears on the webpage
string
Longer description of the team

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORGIAS_UPDATE_TICKETUpdates an existing ticket in Gorgias.

Input Parameters

object
Extra metadata about the ticket
string
The status of the ticket
string
The subject of the ticket
string
The language of the ticket
string
The priority of the ticket
integer
required
The ID of the ticket to update
integer
The ID of the customer for this ticket
string
External identifier for the ticket
integer
ID of the team to assign the ticket to
integer
ID of the user to assign the ticket to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not