Gorgias API

Name: Gorgias API API
Brand: Gorgias API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentCRMCustomer Supportbasic17 EndpointsREST

For Agents

Manage Gorgias helpdesk tickets, customers, messages, macros, and tags so agents can read and reply to e-commerce support conversations.

Connect the Gorgias API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Gorgias API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Gorgias API API.

Create a support ticket linked to a customer with channel and subject metadata

Append a public or internal message to an existing ticket thread

Look up a customer by email or external_id to attach context to a reply

Apply a macro by id to populate a templated response inside a ticket

GET STARTED

Start building with Gorgias API API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Gorgias API, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for Gorgias API, keeping it validated and agent-ready. The Gorgias API is a RESTful interface for the Gorgias helpdesk platform built for e-commerce, covering tickets, customers, macros, integrations, tags, teams, and account settings across 17 endpoints. Authentication uses HTTP Basic with the merchant email and an account API key, scoped per Gorgias subdomain. This spec focuses on the most-used helpdesk objects and is suited to lightweight automations and AI agent integrations.

Use Cases

Patterns agents use Gorgias API API for, with concrete tasks.

★ Automated Order Status Replies

When a shopper messages support asking 'where is my order?', a workflow looks up the order in the e-commerce platform, then POSTs a message to /tickets/{id}/messages with the tracking link and a closing macro. The integration attaches the right tags and assigns the ticket to the shipping team via teams metadata.

Append a public message to ticket 4567890 with the tracking URL https://tracking.example.com/ABC123, apply macro 'order-shipped', and add tag 'shipping-resolved'.

Customer Profile Enrichment

Before an agent replies, hit /customers?email=shopper@example.com to fetch the existing Gorgias customer, merge in firmographic data from a CRM, and show order history alongside the ticket. The enriched profile shortens response time and makes the next message context-aware.

Look up the customer by email shopper@example.com on /customers, capture the customer id, and attach an internal note to the open ticket with their last 5 order ids.

Macro-Driven Refund Workflow

Implement consistent refund replies by applying a pre-approved macro to /tickets/{id} when a refund is granted. The macro inserts the canonical apology, refund amount placeholder, and signature, while the integration records the refund event in the merchant's accounting system. Tags drive reporting on refund volume by reason.

Apply macro id 234 ('full-refund-shipping-damaged') to ticket 5566778, tag the ticket 'refund-issued', and set status to 'resolved'.

AI Agent Triage and Routing

An AI agent reads new tickets, classifies the intent (refund, order status, sizing question), tags them, and assigns the right team. Through Jentic, the agent discovers POST /tickets/{id}/messages and PUT /tickets/{id} by intent and uses a vault-stored API key, never exposing the helpdesk credentials in its prompt.

Classify ticket 6677889 as 'sizing-question', tag it accordingly, assign to team id 12 ('Apparel CX'), and post an internal note explaining the decision.

Key Endpoints

17 endpoints — jentic publishes the only available openapi specification for gorgias api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/account

Retrieve the authenticated account info

GET

/tickets

List tickets with filters

GET

/tickets/{id}

Retrieve a ticket by id

GET

/tickets/{id}/messages

List messages on a ticket

GET

/customers

Search customers by email or id

GET

/macros

List response macros

GET

/tags

List available tags

GET

/account

Retrieve the authenticated account info

GET

/tickets

List tickets with filters

GET

/tickets/{id}

Retrieve a ticket by id

GET

/tickets/{id}/messages

List messages on a ticket

GET

/customers

Search customers by email or id

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Gorgias account email and API key are stored encrypted in the Jentic vault (MAXsystem). Agents receive a scoped Basic auth header at execution time and never see the raw API key.

Intent-based discovery

Agents search by intent (e.g., 'reply to a support ticket') and Jentic returns POST /tickets/{id}/messages with input schema, so the agent calls the right endpoint without browsing the helpdesk docs.

Time to first call

Direct Gorgias integration: 1-3 days for auth, ticket lifecycle, and macro handling. Through Jentic: under 30 minutes from intent search to first reply.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Zendesk Support

General-purpose helpdesk with broad channel and reporting coverage

Choose Zendesk when the merchant supports many product lines or non-e-commerce verticals beyond Gorgias's Shopify focus.

Alternative

Freshdesk

Mid-market helpdesk with omnichannel ticketing

Pick Freshdesk when budget or general SaaS support is the priority over deep e-commerce ticket workflows.

Complementary

Intercom

Conversational messaging and product engagement platform

Use Intercom alongside Gorgias when the team wants in-app chat plus a dedicated e-commerce ticketing system.

FAQs

Specific to using Gorgias API API through Jentic.

Why is there no official OpenAPI spec for Gorgias API?

Gorgias does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Gorgias API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Gorgias API use?

HTTP Basic. Use your Gorgias account email as the username and an API key generated from the Gorgias settings as the password, scoped to the merchant subdomain in the base URL https://{domain}.gorgias.com/api. Through Jentic, the credentials are kept in the encrypted vault and never enter the agent's prompt window.

Can I post a reply to a ticket through the Gorgias API?

Yes. POST /tickets/{id}/messages with the channel, sender, body, and visibility (public to email the customer, internal for an agent-only note). The endpoint returns the new message object with its id and timestamps for downstream tracking.

How do I look up a Gorgias customer by email?

GET /customers with a query parameter such as email=shopper@example.com returns the matching customer record, including the internal customer id, channels, and external identifiers used to merge with your CRM.

How do I integrate the Gorgias API with an AI agent through Jentic?

Run pip install jentic, search 'reply to a gorgias ticket' to find POST /tickets/{id}/messages, load the schema, and execute. Jentic injects the Basic auth header from the vault. Get started at https://app.jentic.com/sign-up.