How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Gorgias Customers API

The Customers API from Gorgias — 2 operation(s) for customers.

Gorgias Customers API is one of 14 APIs that Gorgias publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, authentication docs, and a changelog.

This API exposes 5 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.2.0, at version 2024-01-01.

Requests are made against a single base URL, https://{account}.gorgias.com.

5 operations 2 paths 2 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2024-01-01
Base URL
https://{subdomain}.gorgias.com/api
Authentication
HTTP Basic, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Gorgias Customers API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 6 scopes. By default, every request must be authenticated.

  • basicAuth — Use account email as username and API key as password

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Customers 5
GET
/api/customers
List customers
listCustomers 4 params → 200
POST
/api/customers
Create customer
createCustomer body → 201
GET
/api/customers/{id}
Retrieve a customer
getCustomer 1 param → 200
PUT
/api/customers/{id}
Update a customer
updateCustomer 1 param body → 200
DELETE
/api/customers/{id}
Delete a customer
deleteCustomer 1 param → 204

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Customer (12 properties), Meta (2 properties). Each schema is shown below with its type and property counts.

Customer
object
12 properties
Meta
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gorgias-customers-api-openapi.yml Raw ↑

Other APIs Gorgias publishes across the network.

Gorgias Webhooks
Gorgias Account API
Gorgias Integrations API
Gorgias Macros API
Gorgias Messages API
Gorgias Rules API
Gorgias Surveys API
Gorgias Tags API
Gorgias Teams API
Gorgias Tickets API
Gorgias Users API
Gorgias Views API
Where this information came from

This is an independent, third-party profile of Gorgias Customers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.