---
title: "Gorgias"
description: "Read ticket and tag summaries with granular customer-account authorization."
---

> Documentation Index
> Fetch the complete documentation index at: https://help.tooluse.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Gorgias

<p>Read ticket and tag summaries with granular customer-account authorization.</p>

<details data-command-index><summary>What you can do (2)</summary>
<h2>What you can do</h2>
<p>Available commands: 2 (2 read, 0 write). Enable only the commands your application needs.</p>
<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Command</th>
<th>Effect</th>
</tr>
</thead>
<tbody><tr>
<td><a href="https://help.tooluse.net/integrations/gorgias#command-gorgias-tags-get">Get tag summary</a> — <code>gorgias.tags.get</code></td>
<td>Read</td>
</tr>
<tr>
<td><a href="https://help.tooluse.net/integrations/gorgias#command-gorgias-tickets-get">Get ticket summary</a> — <code>gorgias.tickets.get</code></td>
<td>Read</td>
</tr>
</tbody></table>
</div>
</details>
<h2>Connect and use</h2>

<p><a href="https://www.tooluse.net/tools/integrations/gorgias">Connect and use</a></p>
<p>Open the integration&#39;s connection form to check the available credential source. The source has not been resolved for this documentation export. The instructions below apply when using your own provider account.</p>
<h2>Get your provider credentials</h2>
<p>Follow these steps for Gorgias, then enter the issued values in the connection form below.</p>
<ol>
<li>Create an OAuth app through the Gorgias developer/app submission workflow; public integrations must use OAuth, not private-app API keys. Register <a href="https://api.tooluse.net/v1/oauth/callback">https://api.tooluse.net/v1/oauth/callback</a> exactly and obtain the client ID and secret. Request offline, tags:read and tickets:read only; the integration does not request write:all or identity/email scopes. In My tools &gt; Gorgias &gt; Use my provider credentials, enter your account subdomain only (example for example.gorgias.com), OAuth client ID and secret, select commands and save, then Sign in to provider. The account is bound to consent; changing it requires reconnecting. Gorgias documents confidential Basic form token/refresh/revoke requests and does not currently enable PKCE. Tokens are encrypted and refreshed using the returned expiry. Use existing ticket or tag IDs from Gorgias; metadata summaries omit messages, customer/assignee profiles, order data and writes, but ticket subjects may contain customer text. Disconnect here to revoke the refresh token; existing access tokens may remain valid until expiry, so uninstall in Gorgias to end the installation. App distribution/review remains a provider requirement.</li>
</ol>
<p><a href="https://developers.gorgias.com/docs/set-up-oauth2-app-store">Official credential setup</a></p>
<h2>Where to enter credentials</h2>
<p>In the integration page, sign in, choose your workspace and open Connect. If a <strong>Credentials</strong> choice is shown, select <strong>Use my credentials</strong>. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.</p>
<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Connection field</th>
<th>Requirement</th>
</tr>
</thead>
<tbody><tr>
<td>Gorgias account subdomain</td>
<td>Required</td>
</tr>
<tr>
<td>OAuth access token (optional)</td>
<td>Optional</td>
</tr>
<tr>
<td>Gorgias OAuth client ID</td>
<td>Optional</td>
</tr>
<tr>
<td>Gorgias OAuth client secret</td>
<td>Optional</td>
</tr>
<tr>
<td>Registered OAuth redirect URI (optional)</td>
<td>Optional</td>
</tr>
<tr>
<td>Return URL after authorization</td>
<td>Optional</td>
</tr>
</tbody></table>
</div><p>Open API keys and create a Tooluse.net key for the enabled commands.</p>
<p>Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.</p>
<p><a href="https://help.tooluse.net/clients">Configure Claude Code, Codex or Cursor once</a></p>

<h2>Permissions and results</h2>

<p>If you have more than one workspace, check the selected workspace in the connection or API-key dialog before saving. Roles, enabled commands, expiry and revocation use Tooluse.net&#39;s existing permissions. Disabling a connection or revoking a key immediately prevents new calls.</p>

<p>Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.</p>

<p>Your connection&#39;s daily allowance and key permissions also apply. Adding a connection does not make a provider request.</p>

<p>Calls return the shared execution receipt and a Claude tool_result. Provider output varies by operation; consult the provider documentation for its response fields. Unconfirmed calls should be checked before retrying.</p>

<h2>Call from your client</h2>

<p>Use the shared MCP configuration. Refresh your client&#39;s tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.</p>

<p><a href="https://help.tooluse.net/clients">Configure Claude Code, Codex or Cursor once</a></p>

<h2>Discover your enabled tools</h2>

<p>List permitted tools in Claude format. Read every page using page and size (maximum 100) until all results have been received. Use the returned name, not a catalog capability identifier, in the tool_use block.</p>

<pre><code class="language-bash">curl 'https://api.tooluse.net/v1/tools' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY"
</code></pre>

<p>Find this command in the tool list permitted by your key. Replace svc_FROM_YOUR_TOOL_LIST with its returned name. Use a new Idempotency-Key for each new call and retain it when retrying that same call.</p>

<h2>HTTP call</h2>

<pre><code class="language-bash">curl 'https://api.tooluse.net/v1/tool-calls' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: replace-with-a-new-call-id' \
  --data '{
  "type": "tool_use",
  "id": "toolu_example",
  "name": "svc_FROM_YOUR_TOOL_LIST",
  "input": {
    "path": {
      "tag_id": 5
    }
  }
}'
</code></pre>

<p>Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.</p>

<h2>Commands</h2>

<details id="command-gorgias-tags-get">
<summary><span>Get tag summary — <code>gorgias.<wbr>tags.<wbr>get</code></span></summary>
<p>Read an existing tag’s name, usage count and timestamps in your saved Gorgias account. No ticket changes or customer records.</p>

<p>This is a read operation. Provider rate limits and data access rules still apply.</p>

<p><a href="https://www.tooluse.net/tools/integrations/gorgias?command=gorgias.tags.get">Connect and use</a></p>

<p><strong>Parameters</strong></p>

<p>Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.</p>

<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required in parent</th>
<th>Description</th>
<th>Constraints</th>
</tr>
</thead>
<tbody><tr>
<td><code>path</code></td>
<td>object</td>
<td>Required</td>
<td></td>
<td><code>additionalProperties: false</code></td>
</tr>
<tr>
<td><code>path.tag_id</code></td>
<td>integer</td>
<td>Required</td>
<td>Existing tag ID.</td>
<td><code>minimum: 1; maximum: 9007199254740991</code></td>
</tr>
</tbody></table>
</div>
<p><strong>Full JSON Schema</strong></p>

<p><a href="https://api.tooluse.net/v1/integrations/gorgias/commands/gorgias.tags.get">Full JSON Schema</a></p>

<p><strong>Example input</strong></p>

<pre><code class="language-json">{
  "path": {
    "tag_id": 5
  }
}
</code></pre>

<p>At most 1 provider requests per invocation; timeout: 30 seconds.</p>

</details>
<details id="command-gorgias-tickets-get">
<summary><span>Get ticket summary — <code>gorgias.<wbr>tickets.<wbr>get</code></span></summary>
<p>Read a known ticket’s status, channel, subject, spam flag and timestamps. A subject can contain customer-provided text. Excludes messages, customer and assignee profiles, order data and writes.</p>

<p>This is a read operation. Provider rate limits and data access rules still apply.</p>

<p><a href="https://www.tooluse.net/tools/integrations/gorgias?command=gorgias.tickets.get">Connect and use</a></p>

<p><strong>Parameters</strong></p>

<p>Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.</p>

<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required in parent</th>
<th>Description</th>
<th>Constraints</th>
</tr>
</thead>
<tbody><tr>
<td><code>path</code></td>
<td>object</td>
<td>Required</td>
<td></td>
<td><code>additionalProperties: false</code></td>
</tr>
<tr>
<td><code>path.ticket_id</code></td>
<td>integer</td>
<td>Required</td>
<td>Existing ticket ID.</td>
<td><code>minimum: 1; maximum: 9007199254740991</code></td>
</tr>
</tbody></table>
</div>
<p><strong>Full JSON Schema</strong></p>

<p><a href="https://api.tooluse.net/v1/integrations/gorgias/commands/gorgias.tickets.get">Full JSON Schema</a></p>

<p><strong>Example input</strong></p>

<pre><code class="language-json">{
  "path": {
    "ticket_id": 123
  }
}
</code></pre>

<p>At most 1 provider requests per invocation; timeout: 30 seconds.</p>

</details>
<h2>Errors</h2>

<p>Check the key&#39;s expiry, revocation, workspace and allowed operations.</p>

<p>Reuse the same idempotency key only for the same request.</p>

<p>The connection or provider limit has been reached. Check the receipt before retrying.</p>

<h2>Test the connection</h2>

<p>Open the integration&#39;s commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client&#39;s tool list, use the returned tool name, and check the execution result and usage. Provider charges and permissions still apply. Never test a write against production data without reviewing it.</p>

<p><a href="https://developers.gorgias.com/docs/set-up-oauth2-app-store">Official provider documentation</a></p>

Source: https://help.tooluse.net/integrations/gorgias/index.mdx