Gorgias Account API

openapi: 3.1.0
info:
  title: Gorgias REST Account API
  description: Best-effort OpenAPI 3.1 for the Gorgias REST API, covering tickets, messages, customers, integrations, macros, rules, tags, teams, users, views, surveys, and widgets. Gorgias uses per-account subdomains ({account}.gorgias.com) and supports HTTP Basic authentication with an API key or OAuth2 for public apps.
  version: '2024-01-01'
servers:
- url: https://{account}.gorgias.com
  variables:
    account:
      default: example
      description: Account subdomain
security:
- basicAuth: []
- oauth2:
  - openid
  - accounts.read
  - tickets.read
  - tickets.write
  - customers.read
  - customers.write
tags:
- name: Account
paths:
  /api/account:
    get:
      tags:
      - Account
      summary: Retrieve account
      operationId: getAccount
      responses:
        '200':
          description: Account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
  /api/account/settings:
    get:
      tags:
      - Account
      summary: Retrieve account settings
      operationId: getAccountSettings
      responses:
        '200':
          description: Settings
    put:
      tags:
      - Account
      summary: Update account settings
      operationId: updateAccountSettings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Settings
components:
  schemas:
    Account:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        domain:
          type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Use account email as username and API key as password
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://{account}.gorgias.com/oauth/authorize
          tokenUrl: https://{account}.gorgias.com/oauth/token
          scopes:
            openid: OpenID
            accounts.read: Read account
            tickets.read: Read tickets
            tickets.write: Write tickets
            customers.read: Read customers
            customers.write: Write customers