> ## 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 settings

> Read the Genesys Cloud connection and handoff settings. The client secret is never returned.



## OpenAPI

````yaml get /integrations/genesys/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/genesys/settings:
    get:
      summary: Get Genesys Cloud settings
      description: >-
        Read the Genesys Cloud connection and handoff settings. Answers
        `connected: false` with `settings: null` when Genesys Cloud is not
        connected. The client secret is never returned.
      operationId: getGenesysSettings
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenesysSettingsEnvelopeDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    GenesysSettingsEnvelopeDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/GenesysSettingsEnvelopeDto'
      type: object
      properties:
        connected:
          type: boolean
          description: Whether Genesys Cloud is connected for the organization
        settings:
          anyOf:
            - type: object
              properties:
                region:
                  type: string
                  enum:
                    - mypurecloud.com
                    - use2.us-gov-pure.cloud
                    - usw2.pure.cloud
                    - cac1.pure.cloud
                    - mypurecloud.ie
                    - euw2.pure.cloud
                    - mypurecloud.de
                    - euc2.pure.cloud
                    - aps1.pure.cloud
                    - mypurecloud.jp
                    - apne2.pure.cloud
                    - apne3.pure.cloud
                    - mypurecloud.com.au
                    - sae1.pure.cloud
                    - mec1.pure.cloud
                client_id:
                  type: string
                genesys_org_id:
                  type: string
                genesys_org_name:
                  anyOf:
                    - type: string
                    - type: 'null'
                auth_mode:
                  type: string
                  enum:
                    - manual
                    - oauth_provisioned
                enabled:
                  type: boolean
                live:
                  type: boolean
                current_ticketing_system:
                  anyOf:
                    - type: string
                    - type: 'null'
                needs_reconnect:
                  type: boolean
                open_messaging_integration_id:
                  anyOf:
                    - type: string
                    - type: 'null'
                default_queue_id:
                  anyOf:
                    - type: string
                    - type: 'null'
                handoff_target:
                  type: string
                  enum:
                    - genesys_routing
                    - queue
                    - agent
                handoff_agent_id:
                  anyOf:
                    - type: string
                    - type: 'null'
                on_conversation_end:
                  type: string
                  enum:
                    - close
                    - return_to_ai
                no_agents_policy:
                  type: string
                  enum:
                    - handoff_anyway
                    - stay_with_ai
                    - create_workitem
                default_wrapup_code_id:
                  anyOf:
                    - type: string
                    - type: 'null'
                workitem_mode:
                  type: string
                  enum:
                    - never
                    - on_handoff
                    - email_sessions
                    - all_sessions
                workitem_worktype_id:
                  anyOf:
                    - type: string
                    - type: 'null'
                presence_sync:
                  type: string
                  enum:
                    - 'off'
                    - inbound
                    - two_way
                native_email:
                  type: object
                  properties:
                    enabled:
                      type: boolean
                    queue_id:
                      anyOf:
                        - type: string
                        - type: 'null'
                    human_queue_id:
                      anyOf:
                        - type: string
                        - type: 'null'
                    reply_mode:
                      type: string
                      enum:
                        - agentless
                        - opencx_direct
                    from_address:
                      anyOf:
                        - type: string
                        - type: 'null'
                  required:
                    - enabled
                    - queue_id
                    - human_queue_id
                    - reply_mode
                    - from_address
                  additionalProperties: false
                native_messaging:
                  type: object
                  properties:
                    enabled:
                      type: boolean
                    connector_url:
                      anyOf:
                        - type: string
                        - type: 'null'
                    secret_header:
                      type: string
                  required:
                    - enabled
                    - connector_url
                    - secret_header
                  additionalProperties: false
                smart_routing:
                  type: boolean
                resume_ai_after_wrapup:
                  type: boolean
                wrapup_suggestion_mode:
                  type: string
                  enum:
                    - 'off'
                    - suggest
                    - provisional
              required:
                - region
                - client_id
                - genesys_org_id
                - genesys_org_name
                - auth_mode
                - enabled
                - live
                - current_ticketing_system
                - needs_reconnect
                - open_messaging_integration_id
                - default_queue_id
                - handoff_target
                - handoff_agent_id
                - on_conversation_end
                - no_agents_policy
                - default_wrapup_code_id
                - workitem_mode
                - workitem_worktype_id
                - presence_sync
                - native_email
                - native_messaging
                - smart_routing
                - resume_ai_after_wrapup
                - wrapup_suggestion_mode
              additionalProperties: false
            - type: 'null'
      required:
        - connected
        - settings
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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