Jump to Content
Home
Quickstart
API Reference
Changelog
API Reference
Moon (Dark Mode)
Sun (Light Mode)
Home
Quickstart
API Reference
Changelog
Retrieve a rule
Search
JUMP TO
Gorgias API
Introduction
Authentication
Requests
Errors
Pagination
Limitations
Gorgias REST API
Account
The Account object
Retrieve your account
get
Customers
The Customer object
Create a customer
post
The CustomerChannel object
List customers
get
Delete customers
delete
Retrieve a customer
get
Update a customer
put
Delete a customer
delete
Events
The Event object
List events
get
Retrieve an event
get
Files
The File object
Upload files
post
Integrations
The Integration object
Create an integration
post
List integrations
get
Retrieve an integration
get
Update a integration
put
Delete an integration
delete
Jobs
The Job object
Create a job
post
List jobs
get
Retrieve a job
get
Update a job
put
Cancel a job
delete
Macros
The Macro object
Create a macro
post
The MacroAction object
List macros
get
Retrieve a macro
get
Update a macro
put
Delete a macro
delete
Rules
The Rule object
Create a rule
post
List rules
get
Retrieve a rule
get
Update a rule
put
Delete a rule
delete
Update rules' priorities
post
Satisfaction Surveys
The SatisfactionSurvey object
Create a survey
post
List surveys
get
Retrieve a survey
get
Update a survey
put
Search
Search for resources
post
Users
The User object
Create a user
post
List users
get
Delete users
delete
Retrieve a user
get
Update a user
put
Delete a user
delete
Tags
The Tag object
Create a tag
post
List tags
get
Delete tags
delete
Retrieve a tag
get
Update a tag
put
Delete a tag
delete
Merge tags
put
Tickets
The Ticket object
Create a ticket
post
List tickets
get
Retrieve a ticket
get
Update a ticket
put
Delete a ticket
delete
Ticket Messages
The TicketMessage object
Create a message
post
List messages
get
Retrieve a message
get
Update a message
put
Delete a message
delete
Statistics
The Statistic object
Retrieve a statistic
post
Download a statistic
post
Views
The View object
Create a view
post
List views
get
Retrieve a view
get
Update a view
put
Delete a view
delete
List view's items
get
Search for view's items
put
Widgets
The Widget object
Create a widget
post
List widgets
get
Retrieve a widget
get
Update a widget
put
Delete a widget
delete
Retrieve a rule
get
https://{domain}.gorgias.com/api/rules/
{id}
/
Retrieve a rule based on it's id.
Language
Shell
Node
Ruby
PHP
Python
Credentials
Basic
base64
Basic
:
URL
Base URL
https://
your-domain
.gorgias.com
/api/rules/{id}/
RESPONSE
Click
Try It!
to start a request and see the response here!