Skip to main content
Gorgias
Previewv1.0.0
69 actions · 1 auth method
Ticketing

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · API Key

Admin privileges are required to access the REST API settings.
3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · API Key

4

Use Actions

Connect your agent to the linked account’s actions. See Agent Setup.Other ways to call actions are listed in Protocols & SDKs.

​
Actions

69 actions
Action
Description
Get Account
Retrieve the current Gorgias account information including company details and settings
List Settings
List account settings matching the given parameters
List Customers
Retrieve a paginated list of all customers
Get Customer
Retrieve a single customer by ID
Create Customer
Create a new customer
Update Customer
Update an existing customer
Delete Customers
Delete one or more customers by their IDs
Delete Customer
Delete a single customer by ID
Merge Customers
Merge two customers into one
Set Customer Data
Set a customer’s data
List Customer Custom Fields
List all custom fields for a customer
Update Customer Custom Fields
Update custom fields for a customer
Delete Customer Custom Field
Delete a customer’s custom field value
List Integrations
Retrieve a paginated list of all integrations
Get Integration
Retrieve a single integration by ID
Create Integration
Create a new integration
Update Integration
Update an existing integration
Delete Integration
Delete an integration
List Macros
Retrieve a paginated list of all macros
Get Macro
Retrieve a single macro by ID
Create Macro
Create a new macro
Update Macro
Update an existing macro
Delete Macro
Delete a macro
Archive Macros
Archive multiple macros at once
Unarchive Macros
Unarchive multiple macros at once
List Messages
Retrieve a paginated list of all messages
Get Message
Retrieve a single message by ID
Create Message
Create a new message on a ticket
Update Message
Update an existing message
Delete Message
Delete a message
List Rules
Retrieve a paginated list of all rules
Get Rule
Retrieve a single rule by ID
Create Rule
Create a new rule
Update Rule
Update an existing rule
Delete Rule
Delete a rule
Update Rules Priorities
Update priorities for multiple rules at once
List Tags
Retrieve a paginated list of all tags
Get Tag
Retrieve a single tag by ID
Create Tag
Create a new tag
Update Tag
Update an existing tag
Delete Tag
Delete a tag
Delete Tags
Delete multiple tags at once
Merge Tags
Merge multiple tags into one
List Teams
Retrieve a paginated list of all teams
Get Team
Retrieve a single team by ID
Create Team
Create a new team
Update Team
Update an existing team
Delete Team
Delete a team
List Tickets
Retrieve a paginated list of all tickets
Get Ticket
Retrieve a single ticket by ID
Create Ticket
Create a new support ticket
Update Ticket
Update an existing ticket
Delete Ticket
Permanently delete a ticket
Add Tags To Ticket
Add tags to an existing ticket
Remove Tags From Ticket
Remove tags from an existing ticket
List Ticket Tags
List all tags for a ticket
Set Ticket Tags
Set a ticket’s tags (replaces all existing tags)
List Users
Retrieve a paginated list of all users (agents)
Get User
Retrieve a single user by ID
Create User
Create a new user (agent)
Update User
Update an existing user
Delete User
Delete a user
List Views
Retrieve a paginated list of all views
Get View
Retrieve a single view by ID
Create View
Create a new view
Update View
Update an existing view
Delete View
Delete a view
List View Items
Retrieve tickets in a view
Search View Items
Search for items using custom view filters