Introduction

The Gorgias API is structured with REST in mind. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

On this page, you'll find the complete REST API reference, examples, definitions of objects, and guides. FYI: We're using the same REST API as described here to power our web and mobile applications.

🚧

Compatibility

Resources, resources' attributes, and resources' operations not documented in this documentation should not be used and be considered as non-existing because they are reserved for internal use and can change or be removed at any time without prior notice. You should not rely on them at any time.

📘

Developer newsletter

In the Settings > REST API page of your helpdesk, you will find a button to subscribe to our Developer newsletter. Please do so if you start using our API, as it contains important updates about upcoming and breaking changes to the API.