> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open.cx/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Gorgias settings

> Read the Gorgias domain, whether the integration is enabled, and the user OpenCX assigns tickets to.



## OpenAPI

````yaml get /integrations/gorgias/settings
openapi: 3.1.0
info:
  title: OpenCX API
  description: >

    OpenCX is an AI-powered, all-in-one platform for customer support and
    outbound communications.


    Use this API to manage your OpenCX organization's AI agents, actions,
    conversations, contacts, and more.


    To get started, generate a new API key from the dashboard.


    ## Authentication

    All API endpoints require authentication using a Bearer token. You can
    generate an API key from your OpenCX dashboard.


    ## Rate Limiting

    API requests are rate limited to ensure fair usage. The current limits are:

    - 100 requests per minute for standard endpoints

    - 1000 requests per minute for streaming endpoints


    ## Error Handling

    The API uses standard HTTP status codes and returns detailed error messages
    in the response body.
  version: 1.0-beta
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: http://localhost:8080
    description: Development
  - url: https://api.open.cx
    description: Production
security:
  - bearerAuth: []
paths:
  /integrations/gorgias/settings:
    get:
      summary: Get Gorgias settings
      description: >-
        Read the Gorgias integration settings. Answers `connected: false` with
        `settings: null` when Gorgias is not connected. Credentials are never
        returned.
      operationId: getGorgiasSettings
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GorgiasSettingsEnvelopeDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    GorgiasSettingsEnvelopeDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/GorgiasSettingsEnvelopeDto'
      type: object
      properties:
        connected:
          type: boolean
          description: Whether Gorgias is connected for the organization
        settings:
          anyOf:
            - $ref: '#/components/schemas/GorgiasPublicSettingsDto'
            - type: 'null'
      required:
        - connected
        - settings
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
    GorgiasPublicSettingsDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/GorgiasPublicSettingsDto'
      type: object
      properties:
        domain:
          type: string
          description: Gorgias domain prefix ("company" in company.gorgias.com)
        default_user_id:
          type: string
          description: Gorgias user that OpenCX assigns tickets to
        enabled:
          type: boolean
          description: Whether the integration is enabled
      required:
        - domain
        - default_user_id
        - enabled
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.