> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Gorgias

> Read and act on Gorgias helpdesk tickets, messages, and statuses for e-commerce customer support

## At a glance

* **Availability**: Experimental ([how to enable](/cloud/integrations)).
* **Auth**: Basic auth.
* **Connection**: HTTP Basic auth with `GORGIAS_USERNAME` as the username and `GORGIAS_API_KEY` as the password.
* **Docs**: [https://developers.gorgias.com/reference/authentication](https://developers.gorgias.com/reference/authentication)

## Credentials

Set these per environment. See [Connect an integration](/cloud/integrations).

| Variable                 | Required | Description                                                                                                                                                                             |
| ------------------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `GORGIAS_USERNAME`       | Yes      | Email address of the Gorgias account the API key belongs to (HTTP Basic username) [Docs](https://developers.gorgias.com/reference/authentication).                                      |
| `GORGIAS_API_KEY`        | Yes      | Gorgias REST API key (HTTP Basic password), created under Settings → REST API [Docs](https://developers.gorgias.com/reference/authentication).                                          |
| `GORGIAS_ACCOUNT_DOMAIN` | Yes      | Your Gorgias account subdomain, e.g. 'acme' for acme.gorgias.com - passed as the accountDomain parameter on every tool [Docs](https://developers.gorgias.com/reference/authentication). |

## Setup

1. **Get a Gorgias account**: Sign up at [https://www.gorgias.com](https://www.gorgias.com) - new accounts start with a free trial you can use for testing. Note your account subdomain (the 'acme' in acme.gorgias.com).
2. **Create a REST API key**: In your Gorgias dashboard, open Settings → REST API. Copy the Base API URL (https\://\<your-domain>.gorgias.com/api), your username (your account email), and create/copy the API key (password).
3. **Store the credentials**: Add GORGIAS\_USERNAME=\<your account email>, GORGIAS\_API\_KEY=\<your API key>, and GORGIAS\_ACCOUNT\_DOMAIN=\<your subdomain> to your .env file. The API uses HTTP Basic auth with email as username and API key as password.
4. **Verify access**: Run the List Tickets tool with your account subdomain as accountDomain. You should get back a page of tickets (empty data array on a fresh account).

* Every tool takes an accountDomain path parameter - pass the value stored in GORGIAS\_ACCOUNT\_DOMAIN
* API keys inherit the permissions of the user they belong to; create the key from an account with access to the tickets you need
* Creating a message with channel 'email' actually emails the customer - use channel 'internal-note' for private notes

Provider API reference: [https://developers.gorgias.com/reference](https://developers.gorgias.com/reference)

## Tools

| Tool                  | Access | Description                                                                                            |
| --------------------- | ------ | ------------------------------------------------------------------------------------------------------ |
| List Tickets          | Read   | List helpdesk tickets, optionally filtered by customer or ordered by creation/update time              |
| Get Ticket            | Read   | Retrieve a single ticket with its full details (customer, assignee, status, tags)                      |
| List Ticket Messages  | Read   | List the messages (customer and agent) in a ticket's conversation thread                               |
| Create Ticket Message | Write  | Add a message to a ticket, e.g. an agent reply to the customer or an internal note                     |
| Create Ticket         | Write  | Create a new helpdesk ticket with an initial message, e.g. to open an issue on behalf of a customer    |
| List Customers        | Read   | List or search helpdesk customers, e.g. to find a customer ID by email for ticket filtering            |
| List Users            | Read   | List helpdesk agents/users, e.g. to find the user IDs needed for ticket assignment and message senders |
| Update Ticket Status  | Write  | Update a ticket, e.g. close or reopen it, or change its assignee                                       |

## Example prompts

* List my most recent Gorgias tickets and summarize which are still open and what the customers are asking about.
* Read the messages in a Gorgias ticket I specify and draft a friendly agent reply addressing the customer's issue.
* Check a Gorgias ticket I specify; if the issue looks resolved, post a closing reply and set the ticket status to closed.