| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://{subdomain}.gorgias.com/api | link | — | — | — |
Actions (37)
Customers · 15
- Add customer tagsPOST /api/customers/{id}/tags
Add tags to a customer.
documented - Create customerPOST /api/customers
Create a new customer.
documented - Delete customerDELETE /api/customers/{id}
Delete a customer by ID.
documented - Delete customer by IDDELETE /api/customers/{id}
Delete a customer by ID.
documented - Delete customersDELETE /api/customers
Bulk delete customers.
documented - List customer eventsGET /api/customers/{id}/events
List events related to a customer.
documented - List customer tagsGET /api/customers/{id}/tags
List tags associated with a customer.
documented - List customersGET /api/customers
List customers (paginated).
documented - Merge two customersPOST /api/customers/merge
Merge data from a source customer into a target customer and remove the source.
documented - Remove customer tagDELETE /api/customers/{id}/tags/{tag_id}
Remove a tag from a customer.
documented - Retrieve a customerGET /api/customers/{id}
Retrieve a customer by ID.
documented - Retrieve customer dataGET /api/customers/{id}/data
Get a customer's data payload.
documented - Set customer dataPUT /api/customers/{id}/data
Set or update a customer's data payload.
documented - Update customerPUT /api/customers/{id}
Update a customer by ID.
documented - Update customer dataPOST /api/customers/{id}/data
Update a customer's data payload.
documented
Account · 8
- Create account settingPOST /api/account/settings
Create a setting for the current account.
documented - Create account settingPOST /api/account/settings
Create an account setting.
documented - List account settingsGET /api/account/settings
List account settings.
documented - List account settingsGET /api/account/settings
List settings for the current account.
documented - Retrieve accountGET /api/account
Retrieve details of the current Gorgias account.
documented - Retrieve accountGET /api/account
Retrieve details of the current account.
documented - Update account settingPUT /api/account/settings/{id}
Update an account setting.
documented - Update account settingPUT /api/account/settings/{id}
Update a specific account setting.
documented
Custom Fields · 5
- Bulk update custom fieldsPUT /api/custom-fields
Bulk update a list of custom fields.
documented - Create custom fieldPOST /api/custom-fields
Create a new custom field.
documented - List custom fieldsGET /api/custom-fields
List custom fields.
documented - Retrieve custom fieldGET /api/custom-fields/{id}
Retrieve a custom field by ID.
documented - Update custom fieldPUT /api/custom-fields/{id}
Update a custom field by ID.
documented
Integrations · 5
- Create integrationPOST /api/integrations
Create an integration.
documented - Delete integrationDELETE /api/integrations/{id}
Delete an integration by ID.
documented - List integrationsGET /api/integrations
List integrations.
documented - Retrieve integrationGET /api/integrations/{id}
Retrieve an integration by ID.
documented - Update integrationPUT /api/integrations/{id}
Update an integration by ID.
documented