Gorgias website screenshot

Gorgias

Gorgias is a customer support and helpdesk platform purpose-built for ecommerce brands, with deep native integrations into Shopify, BigCommerce, Magento, and other commerce stacks to unify email, chat, social, SMS, and voice conversations alongside order data. The platform automates repetitive support tasks with AI agents and macros, surfaces revenue attribution for support interactions, and powers self-service flows on storefronts. The Gorgias REST API provides full CRUD access to tickets, customers, macros, integrations, and widgets using HTTP Basic authentication or OAuth2 for public apps.

2 APIs 0 Features
Customer SupportHelpdeskEcommerceShopifyTicketsConversations

APIs

Gorgias REST API

REST API for managing tickets, messages, customers, macros, rules, integrations, widgets, and account data inside the Gorgias helpdesk. Authentication uses HTTP Basic with an em...

Gorgias Webhooks

Outbound webhook surface delivered through Gorgias HTTP Integrations. When configured triggers fire on a Gorgias account, Gorgias sends an HTTP request to the URL set on the Tic...

Collections

Gorgias REST API

OPEN

Event Specifications

Gorgias Webhooks (HTTP Integrations)

Best-effort AsyncAPI 2.6 description of the Gorgias webhook surface, delivered through Gorgias HTTP Integrations. When the configured triggers fire inside a Gorgias account, Gor...

ASYNCAPI

Resources

👥
GitHubOrganization
GitHubOrganization
🔗
Website
Website
🔗
Documentation
Documentation
🔗
Help Center
Help Center
💰
Pricing
Pricing
📝
Signup
Signup
🟢
StatusPage
StatusPage
📄
ChangeLog
ChangeLog
🔗
LinkedIn
LinkedIn
🔗
LlmsText
LlmsText

Sources

Raw ↑ 
opencollection: 1.0.0
info:
  name: Gorgias REST API
  version: '2024-01-01'
request:
  auth:
    type: basic
    username: '{{username}}'
    password: '{{password}}'
items:
- info:
    name: Account
    type: folder
  items:
  - info:
      name: Retrieve account
      type: http
    http:
      method: GET
      url: https://{account}.gorgias.com/api/account
    docs: Retrieve account
  - info:
      name: Retrieve account settings
      type: http
    http:
      method: GET
      url: https://{account}.gorgias.com/api/account/settings
    docs: Retrieve account settings
  - info:
      name: Update account settings
      type: http
    http:
      method: PUT
      url: https://{account}.gorgias.com/api/account/settings
      body:
        type: json
        data: '{}'
    docs: Update account settings
- info:
    name: Customers
    type: folder
  items:
  - info:
      name: List customers
      type: http
    http:
      method: GET
      url: https://{account}.gorgias.com/api/customers
      params:
      - name: cursor
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
      - name: email
        value: ''
        type: query
      - name: external_id
        value: ''
        type: query
    docs: List customers
  - info:
      name: Create customer
      type: http
    http:
      method: POST
      url: https://{account}.gorgias.com/api/customers
      body:
        type: json
        data: '{}'
    docs: Create customer
  - info:
      name: Retrieve a customer
      type: http
    http:
      method: GET
      url: https://{account}.gorgias.com/api/customers/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Retrieve a customer
  - info:
      name: Update a customer
      type: http
    http:
      method: PUT
      url: https://{account}.gorgias.com/api/customers/:id
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update a customer
  - info:
      name: Delete a customer
      type: http
    http:
      method: DELETE
      url: https://{account}.gorgias.com/api/customers/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Delete a customer
- info:
    name: Tickets
    type: folder
  items:
  - info:
      name: List tickets
      type: http
    http:
      method: GET
      url: https://{account}.gorgias.com/api/tickets
      params:
      - name: cursor
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
      - name: customer_id
        value: ''
        type: query
      - name: assignee_user_id
        value: ''
        type: query
      - name: status
        value: ''
        type: query
    docs: List tickets
  - info:
      name: Create ticket
      type: http
    http:
      method: POST
      url: https://{account}.gorgias.com/api/tickets
      body:
        type: json
        data: '{}'
    docs: Create ticket
  - info:
      name: Retrieve a ticket
      type: http
    http:
      method: GET
      url: https://{account}.gorgias.com/api/tickets/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Retrieve a ticket
  - info:
      name: Update a ticket
      type: http
    http:
      method: PUT
      url: https://{account}.gorgias.com/api/tickets/:id
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update a ticket
  - info:
      name: Delete a ticket
      type: http
    http:
      method: DELETE
      url: https://{account}.gorgias.com/api/tickets/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Delete a ticket
- info:
    name: Messages
    type: folder
  items:
  - info:
      name: List messages for a ticket
      type: http
    http:
      method: GET
      url: https://{account}.gorgias.com/api/tickets/:id/messages
      params:
      - name: id
        value: ''
        type: path
    docs: List messages for a ticket
  - info:
      name: Create a message on a ticket
      type: http
    http:
      method: POST
      url: https://{account}.gorgias.com/api/tickets/:id/messages
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Create a message on a ticket
- info:
    name: Tags
    type: folder
  items:
  - info:
      name: Add tags to a ticket
      type: http
    http:
      method: POST
      url: https://{account}.gorgias.com/api/tickets/:id/tags
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Add tags to a ticket
  - info:
      name: List tags
      type: http
    http:
      method: GET
      url: https://{account}.gorgias.com/api/tags
    docs: List tags
  - info:
      name: Create tag
      type: http
    http:
      method: POST
      url: https://{account}.gorgias.com/api/tags
      body:
        type: json
        data: '{}'
    docs: Create tag
  - info:
      name: Get tag
      type: http
    http:
      method: GET
      url: https://{account}.gorgias.com/api/tags/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Get tag
  - info:
      name: Update tag
      type: http
    http:
      method: PUT
      url: https://{account}.gorgias.com/api/tags/:id
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update tag
  - info:
      name: Delete tag
      type: http
    http:
      method: DELETE
      url: https://{account}.gorgias.com/api/tags/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Delete tag
- info:
    name: Macros
    type: folder
  items:
  - info:
      name: List macros
      type: http
    http:
      method: GET
      url: https://{account}.gorgias.com/api/macros
    docs: List macros
  - info:
      name: Create macro
      type: http
    http:
      method: POST
      url: https://{account}.gorgias.com/api/macros
      body:
        type: json
        data: '{}'
    docs: Create macro
  - info:
      name: Get macro
      type: http
    http:
      method: GET
      url: https://{account}.gorgias.com/api/macros/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Get macro
  - info:
      name: Update macro
      type: http
    http:
      method: PUT
      url: https://{account}.gorgias.com/api/macros/:id
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update macro
  - info:
      name: Delete macro
      type: http
    http:
      method: DELETE
      url: https://{account}.gorgias.com/api/macros/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Delete macro
- info:
    name: Rules
    type: folder
  items:
  - info:
      name: List rules
      type: http
    http:
      method: GET
      url: https://{account}.gorgias.com/api/rules
    docs: List rules
  - info:
      name: Create rule
      type: http
    http:
      method: POST
      url: https://{account}.gorgias.com/api/rules
      body:
        type: json
        data: '{}'
    docs: Create rule
  - info:
      name: Get rule
      type: http
    http:
      method: GET
      url: https://{account}.gorgias.com/api/rules/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Get rule
  - info:
      name: Update rule
      type: http
    http:
      method: PUT
      url: https://{account}.gorgias.com/api/rules/:id
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update rule
  - info:
      name: Delete rule
      type: http
    http:
      method: DELETE
      url: https://{account}.gorgias.com/api/rules/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Delete rule
- info:
    name: Views
    type: folder
  items:
  - info:
      name: List views
      type: http
    http:
      method: GET
      url: https://{account}.gorgias.com/api/views
    docs: List views
  - info:
      name: Create view
      type: http
    http:
      method: POST
      url: https://{account}.gorgias.com/api/views
      body:
        type: json
        data: '{}'
    docs: Create view
  - info:
      name: Search items in a view
      type: http
    http:
      method: GET
      url: https://{account}.gorgias.com/api/views/:id/items
      params:
      - name: id
        value: ''
        type: path
      - name: cursor
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
    docs: Search items in a view
- info:
    name: Integrations
    type: folder
  items:
  - info:
      name: List integrations
      type: http
    http:
      method: GET
      url: https://{account}.gorgias.com/api/integrations
    docs: List integrations
  - info:
      name: Create integration
      type: http
    http:
      method: POST
      url: https://{account}.gorgias.com/api/integrations
      body:
        type: json
        data: '{}'
    docs: Create integration
  - info:
      name: Get integration
      type: http
    http:
      method: GET
      url: https://{account}.gorgias.com/api/integrations/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Get integration
  - info:
      name: Update integration
      type: http
    http:
      method: PUT
      url: https://{account}.gorgias.com/api/integrations/:id
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update integration
  - info:
      name: Delete integration
      type: http
    http:
      method: DELETE
      url: https://{account}.gorgias.com/api/integrations/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Delete integration
- info:
    name: Users
    type: folder
  items:
  - info:
      name: List users
      type: http
    http:
      method: GET
      url: https://{account}.gorgias.com/api/users
    docs: List users
  - info:
      name: Create user
      type: http
    http:
      method: POST
      url: https://{account}.gorgias.com/api/users
      body:
        type: json
        data: '{}'
    docs: Create user
  - info:
      name: Get user
      type: http
    http:
      method: GET
      url: https://{account}.gorgias.com/api/users/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Get user
- info:
    name: Teams
    type: folder
  items:
  - info:
      name: List teams
      type: http
    http:
      method: GET
      url: https://{account}.gorgias.com/api/teams
    docs: List teams
  - info:
      name: Create team
      type: http
    http:
      method: POST
      url: https://{account}.gorgias.com/api/teams
      body:
        type: json
        data: '{}'
    docs: Create team
- info:
    name: Surveys
    type: folder
  items:
  - info:
      name: List satisfaction surveys
      type: http
    http:
      method: GET
      url: https://{account}.gorgias.com/api/satisfaction-surveys
    docs: List satisfaction surveys
  - info:
      name: Create satisfaction survey
      type: http
    http:
      method: POST
      url: https://{account}.gorgias.com/api/satisfaction-surveys
      body:
        type: json
        data: '{}'
    docs: Create satisfaction survey
- info:
    name: Widgets
    type: folder
  items:
  - info:
      name: List widgets
      type: http
    http:
      method: GET
      url: https://{account}.gorgias.com/api/widgets
    docs: List widgets
  - info:
      name: Create widget
      type: http
    http:
      method: POST
      url: https://{account}.gorgias.com/api/widgets
      body:
        type: json
        data: '{}'
    docs: Create widget
  - info:
      name: Get widget
      type: http
    http:
      method: GET
      url: https://{account}.gorgias.com/api/widgets/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Get widget
bundled: true