Macha

How to Find Your Gorgias API Key

Abbas, Customer Support & AI, Macha

Written by

Ankeet Guha, Co-founder & CTO, Macha

Reviewed by

Published July 24, 2026

Updated July 24, 2026

Your Gorgias API key is the credential that lets outside tools — a data warehouse, a Shopify app, a reporting script, or an AI agent layer — read and write the tickets in your help desk without a human logging in. It lives in one specific place in Settings, it pairs with your account email to authenticate, and it grants full access to your account's data, which is exactly why knowing how to find it, how to regenerate it, and how to store it matters as much for security as it does for setup. This guide walks the exact click-path, shows how to create or reset the key, explains how per-user keys and permissions actually work, and stays honest about where the native REST API stops and where you'll want something on top.

How to Find Your Gorgias API Key

Where the API key lives (the exact click-path)

Everything you need sits on one page. Per Gorgias's Access your Gorgias REST API credentials documentation, the path is:

  1. Click the Settings icon in the bottom-left corner of your Gorgias helpdesk.
  2. In the settings menu, find Account and select REST API.
  3. Under the API Access & Credentials heading, you'll see three things: the Base API URL, your Username, and the Password (API Key) field.

That single screen is the whole credential set. There's no separate developer console to hunt through — if you can reach Settings, you can reach your key. One access caveat worth knowing up front: only the account owner and administrators can view these credentials or create a key. If the REST API page looks empty or read-only for you, your role is the reason, not a bug.

The Gorgias REST API settings page (Settings > REST API) showing Base API URL, Username (email), and the Password (API Key) field — the exact location to find your API key. The key value is masked by Gorgias itself.
The Gorgias REST API settings page (Settings > REST API) showing Base API URL, Username (email), and the Password (API Key) field — the exact location to find your API key. The key value is masked by Gorgias itself.

What the three fields actually mean

The credentials page gives you everything an API request needs, but each field plays a distinct role.

  • Base API URL — the root address every request hits, in the form https://{your-domain}.gorgias.com/api/. Your {your-domain} is the subdomain you log in with, so a store on northwind.gorgias.com calls https://northwind.gorgias.com/api/.
  • Username — this is simply the email address on your account. It is not a separate API identity; it's the login email, used as the username half of the credential pair.
  • Password (API Key) — the generated secret. Gorgias masks it in-product (you'll see dots, not the raw value), so treat the moment you first create it as your one clean chance to copy it somewhere safe.

If you want the full picture of what you can do once you're authenticated — endpoints, pagination, examples — the companion walkthrough on how to use the Gorgias API picks up where this page leaves off. And if you're newer to the platform overall, what is Gorgias sets the context for how tickets, rules, and integrations fit together.

How to create your API key

If you've never generated one, the Password (API Key) field will offer to make it for you.

  1. Go to Settings → Account → REST API.
  2. Under Password (API Key), click Create API Key.
  3. The key is generated immediately and displayed alongside your Base URL and username.
  4. Copy it now and store it in a password manager or your integration's secrets store. Because the value stays masked afterward, you don't want to be hunting for it later.

That's it — no approval flow, no waiting. The key is live the instant it's created.

How authentication works (HTTP Basic + base64)

Gorgias uses HTTP Basic Authentication. You take your USERNAME:API_KEY pair — your email, a colon, then the key — and base64-encode the whole string into the Authorization header. Per the Access Tokens (API Keys) developer docs, "the USERNAME:API_KEY pair has to be a base64 encoded string."

A minimal request to list tickets looks like this:

curl https://northwind.gorgias.com/api/tickets \
  -H "Authorization: Basic $(printf '[email protected]:YOUR_API_KEY' | base64)" \
  -H "Content-Type: application/json"

Most HTTP libraries do the base64 step for you if you pass the username and key as basic-auth credentials:

import requests

resp = requests.get(
    "https://northwind.gorgias.com/api/tickets",
    auth=("[email protected]", "YOUR_API_KEY"),  # library base64-encodes the pair
    headers={"Content-Type": "application/json"},
)
print(resp.status_code, resp.json())

One important historical note: as of February 3, 2022, Gorgias stopped accepting user passwords for API authentication — per the changelog, only requests authenticated with an API key are accepted. So even though the field is labelled "Password (API Key)," you must use the generated key, never your login password.

Per-user keys and permissions

This is the part teams most often miss, and it's the good kind of surprise. Each API key is tied to the user who created it and inherits that user's permission level. A key generated by an admin can do admin things; a key generated by an Observer Agent can only perform actions an Observer is allowed to perform. Nothing you build via the API escalates past the role of the person whose key it uses.

That has two practical consequences worth planning for:

  • Scope keys deliberately. For a read-only reporting sync, generate the key under a user with a narrower role rather than the account owner, so a leaked key can't rewrite tickets.
  • Offboarding matters. If the user a key belongs to is deactivated or changes roles, the key's effective permissions change with them. Tie integration keys to a stable, purpose-built account where you can.

A last distinction: API-key auth is for private apps only — the internal integrations you build for your account. If you're building a public app to distribute to other Gorgias merchants, you use OAuth2 instead.

Rotating and revoking: security hygiene

Gorgias is blunt about the stakes: "Your API key grants full access to your account's data. Once you've copied it, store it somewhere secure and don't share it with anyone." Treat it like a production password, because functionally it is one.

To rotate the key:

  1. Go to Settings → Account → REST API.
  2. Next to Password (API Key), click Reset, then confirm with OK.
  3. Immediately update every integration that used the old key.

The catch: resetting invalidates the old key instantly. There's no grace window where both keys work, so a reset done carelessly will break a live Shopify app or reporting job the moment you confirm it. Plan rotations for a quiet window and have the new key ready to paste into each dependent system. A good baseline hygiene routine: rotate on any suspected exposure, rotate when a team member with key access leaves, and never paste a key into a Slack thread, a shared doc, or a git commit.

The honest limits — and where a layer picks up

The REST API and its key are genuinely capable: authenticated, permission-aware, and stable. But knowing where the raw API stops saves a lot of wasted effort.

First, rate limits are real and plan-tiered. Per the developer Rate Limits reference, Gorgias uses a leaky-bucket algorithm; API-key auth is capped tighter than OAuth2, and the per-second ceiling scales with your plan (lower on Starter/Basic, higher on Pro/Advanced, custom on Enterprise). Watch the X-Gorgias-Account-Api-Call-Limit header for live usage and respect Retry-After when you're throttled, or a bulk backfill will grind to a halt.

Second — and this is the bigger one — a key gets you access, not intelligence. The API can hand your integration a ticket's contents, but it won't read that ticket, understand what the shopper is asking, check the order status, and write the reply. Building that yourself means standing up auth, retries, ticket parsing, retrieval over your help-center content, and the reasoning logic — and it's worth being clear-eyed about that build-versus-buy tradeoff before you commit engineering time to it.

This is the seam where an AI agent layer fits. Macha is one such layer: it runs on top of the Gorgias you already use as a native connector — it does not replace your help desk. You connect Macha with the very credentials from this page, and it reads and writes the same tickets your team does, drafting grounded first replies, triaging by intent rather than keyword, and looking up order or account status through a custom tool that turns a REST endpoint into something the agent can call. Because it authenticates through the standard connector, you keep Gorgias's own rules and customer sidebar exactly as they are — the Macha–Gorgias integration sits alongside them, not instead of them. (Credits are consumed per AI action, not per resolution — see the pricing breakdown.)

The clean division of labour: let the Gorgias API and its key be the secure pipe into your ticket data, and layer an agent on top for the reasoning the raw pipe can't do.

FAQ

Where is the API key in Gorgias? Click the Settings icon in the bottom-left corner, then go to Account → REST API. Under API Access & Credentials you'll find the Base API URL, your Username (account email), and the Password (API Key) field. Only the account owner and admins can see or create it.

What is my Gorgias API username? It's the email address on your account. Gorgias uses HTTP Basic Auth, pairing that email with your API key as USERNAME:API_KEY, base64-encoded into the Authorization header.

How do I reset or regenerate my Gorgias API key? On the REST API page, click Reset next to Password (API Key) and confirm. This invalidates the old key immediately, so update every integration that relied on it right away — there's no overlap period where both keys work.

Can I use my login password instead of an API key? No. Since February 3, 2022, Gorgias no longer accepts user passwords for API authentication. You must use a generated API key.

Does the API key have the same permissions as me? Yes. Each key inherits the permission level of the user who created it. A key made by an Observer Agent can only perform Observer-level actions, so scope keys to the narrowest role that gets the job done.

Ready to put your Gorgias key to work on real automation? Start a free trial of Macha and connect it to your Gorgias help desk in minutes.

Macha

About Macha

Macha is an AI agent platform that works on top of the help desk you already use — Zendesk, Freshdesk, Gorgias, or Front — and connects to the rest of your stack, even your own internal systems. Its AI agents resolve tickets and automate entire workflows end to end, all set up in plain English, no code. Learn more about Macha →

Zendesk
5.0 on Zendesk Marketplace

Loved by support teams worldwide

See what support teams are saying about Macha AI.

The application seems excellent to me! We are still testing, and we need support for some details and they were extremely efficient too!

Daniela Costa

Daniela Costa

Head of Support, Seabra

Macha has been a great addition to our support toolkit. It generates clear, well-organized responses that fit naturally into our workflow. One feature we particularly appreciate is its ability to automatically reply in the same language as the ticket.

Marius F

Marius F

Support Head, Zentana

We've been using Macha for a little while now and it's been really great addition so far! It's powerful, convenient, and makes getting work done a lot easier for our agents.

Alexander Wedén

Alexander Wedén

Head of Support

Support team is very helpful and responsive. Really enjoy how lightweight this is within Zendesk itself vs other more intrusive tools.

Cathleen Wright

Cathleen Wright

Zendesk Admin, Cortex IO

So far it's pretty good! Our queries are a little nuanced, so we can't always use it, but it's got enough utility for us. It can even incorporate our bilingual country with greetings in a second language.

Jae Oliver

Jae Oliver

Head of Support, Wise

Really enjoying using Macha, it has made a noticeable difference to our support team in a short amount of time. I really like the ticket summary feature, saves us a lot of time.

Harry Jackson

Harry Jackson

Head of Support, Crumb

Macha AI is a great addition to my workspace! It's powerful, convenient, and it really makes productivity so much easier for our agents!

Dave G

Dave G

Head of Support, Cyber Power Systems

Very impressed! AI integration for Zendesk has certainly come a long way and Macha seems to set the standard for now. This will for sure save lot of time in our support team.

Pauli Juel

Pauli Juel

Head of CS, Dokument24

Macha has been working great for us so far! The auto-responses are accurate and our resolution time has dropped significantly.

Lana T

Lana T

Zendesk Admin, Swotzy

Macha AI is a great addition. The knowledge base feature means our agents always have the right answers at their fingertips.

Mischa Wolf

Mischa Wolf

Head of Support, Topi

We're enjoying this integration so far. It's made our support team more efficient and our customers get faster responses.

Paula G

Paula G

Head of Customer Support, Xly Studio

The team enjoys using it. It saves considerable time on common questions and the integration options are excellent.

Kilian Leister

Kilian Leister

Support Head, Didriksons

Ready to supercharge your team with AI?

Get started in minutes. Connect your tools, configure your agents, and let AI handle the rest.

500 free credits · no time limit, no credit card