> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://apidocs.polytomic.com/2024-02-08/guides/configuring-your-connections/connections/gorgias/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://apidocs.polytomic.com/_mcp/server.

# Gorgias

Supports:
* ✅ Models
* ✅ Bulk sync source
* ✅ Connection Proxy


## Connection

### Configuration
<table>
<thead>
<tr>
<th>Name</th><th>Type</th><th>Description</th><th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>auth_method</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">Authentication method<br/><br/>Accepted values: `api_key` <a href="#auth-method-api-key">↓</a>, `private_app` <a href="#auth-method-private-app">↓</a></td>
<td><code>required</code></td>
</tr>
<tr>
<td><code>domain</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">Domain<br/><br/>Your Gorgias subdomain (e.g. 'acme' for acme.gorgias.com)</td>
<td><code>required</code></td>
</tr>
</tbody>
</table>

<a id="auth-method-api-key"></a>

#### `auth_method`

When `auth_method` is `api_key`:

<table>
<thead>
<tr>
<th>Name</th><th>Type</th><th>Description</th><th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>apikey</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">API key</td>
<td><code>required</code></td>
</tr>
<tr>
<td><code>email</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">Email<br/><br/>Your Gorgias account email address</td>
<td><code>required</code></td>
</tr>
</tbody>
</table>

```json
{
  "name": "Gorgias connection",
  "type": "gorgias",
  "configuration": {
    "apikey": "secret-key",
    "auth_method": "api_key",
    "domain": "acme",
    "email": "user@example.com"
  }
}
```

<a id="auth-method-private-app"></a>

When `auth_method` is `private_app`:

<table>
<thead>
<tr>
<th>Name</th><th>Type</th><th>Description</th><th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>client_id</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">Client ID</td>
<td><code>required</code></td>
</tr>
<tr>
<td><code>client_secret</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">Client secret</td>
<td><code>required</code></td>
</tr>
</tbody>
</table>

```json
{
  "name": "Gorgias connection",
  "type": "gorgias",
  "configuration": {
    "auth_method": "private_app",
    "client_id": "6218fa8cfe1b2a3c4d5e6f70",
    "client_secret": "secret",
    "domain": "acme"
  }
}
```



## Model Sync
### Source
#### Configuration
<table>
<thead>
<tr>
<th>Name</th><th>Type</th><th>Description</th><th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>object</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">Object</td>
<td><code>required</code></td>
</tr>
</tbody>
</table>


#### Example
```json
{
  ...
  "configuration": {
    "object": "object"
  }
}
```







## Bulk Sync
### Source
Gorgias connections may be used as a bulk sync source. No additional configuration options are required.