gorgias-developers
{{user.name}}
Log In
Developer Documentation
Guides and technical documentation to help you start building integrations on Gorgias
Home
Guides
API Reference
Home
Guides
Tutorials
API Reference
Reference
Changelog
Discussions
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
Home
Guides
API Reference
{{search.symbol}}K
discard
Save Edits
Submit
Suggested Edits
Building Apps
Why build on Gorgias?
Publishing to the integration page
Tutorials
Integrate with a new channel
Show 3rd-party data in tickets
Sync Gorgias with a database
Building Apps
Why build on Gorgias?
Publishing to the integration page
Tutorials
Integrate with a new channel
Show 3rd-party data in tickets
Sync Gorgias with a database
Gorgias API
Introduction
Authentication
Requests
Errors
Pagination
Limitations
Gorgias REST API
Account
The Account object
get
Retrieve your account
Customers
The Customer object
The CustomerChannel object
post
Create a customer
get
List customers
get
Retrieve a customer
put
Update a customer
delete
Delete a customer
delete
Delete customers
Events
The Event object
get
List events
get
Retrieve an event
Files
The File object
post
Upload files
Jobs
The Job object
post
Create a job
get
List jobs
get
Retrieve a job
put
Update a job
delete
Cancel a job
Macros
The Macro object
The MacroAction object
post
Create a macro
get
List macros
get
Retrieve a macro
put
Update a macro
delete
Delete a macro
Rules
The Rule object
post
Create a rule
get
List rules
get
Retrieve a rule
put
Update a rule
post
Update rules' priorities
delete
Delete a rule
Satisfaction Surveys
The SatisfactionSurvey object
post
Create a survey
get
List surveys
get
Retrieve a survey
put
Update a survey
Search
post
Search for resources
Users
The User object
post
Create a user
get
List users
get
Retrieve a user
put
Update a user
delete
Delete a user
delete
Delete users
Tags
The Tag object
post
Create a tag
get
List tags
get
Retrieve a tag
put
Update a tag
put
Merge tags
delete
Delete a tag
delete
Delete tags
Tickets
The Ticket object
post
Create a ticket
get
List tickets
get
Retrieve a ticket
put
Update a ticket
delete
Delete a ticket
Ticket Messages
The TicketMessage object
post
Create a message
get
List messages
get
Retrieve a message
put
Update a message
delete
Delete a message
Statistics
The Statistic object
post
Retrieve a statistic
post
Download a statistic
Views
The View object
post
Create a view
get
List views
get
Retrieve a view
put
Update a view
delete
Delete a view
get
List view's items
put
Search for view's items
Powered by
Start Building on Gorgias Today
Building Apps
Why build on Gorgias?
Publishing to the integration page
Tutorials
Integrate with a new channel
Show 3rd-party data in tickets
Sync Gorgias with a database