> ## 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 Twilio Flex integration settings

> Read the Twilio Flex workspace, AI queue and workers, handoff toggles, and synced attributes.



## OpenAPI

````yaml get /integrations/twilio-flex/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/twilio-flex/settings:
    get:
      summary: Get Twilio Flex integration settings
      description: >-
        Read the Twilio Flex integration configuration. Answers `connected:
        false` with `settings: null` when Twilio Flex is not connected. The auth
        token is never returned.
      operationId: getTwilioFlexSettings
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  connected:
                    type: boolean
                  settings:
                    anyOf:
                      - type: object
                        properties:
                          account_sid:
                            type: string
                            description: Twilio Account SID
                          workspace_sid:
                            type: string
                            description: TaskRouter workspace SID
                          ai_queue_sid:
                            anyOf:
                              - type: string
                              - type: 'null'
                            description: >-
                              TaskRouter queue for AI-handled conversations;
                              null = none
                          ai_worker_sids:
                            type: array
                            items:
                              type: string
                            description: TaskRouter workers that represent the AI
                          ai_chat_capacity:
                            anyOf:
                              - type: integer
                                minimum: -9007199254740991
                                maximum: 9007199254740991
                              - type: 'null'
                          ai_worker_email_domain:
                            anyOf:
                              - type: string
                              - type: 'null'
                            description: >-
                              Domain used to give each AI worker an email
                              attribute; null = none
                          enabled:
                            type: boolean
                          internal_notes_enabled:
                            type: boolean
                            description: >-
                              Post the handoff summary into the conversation
                              (visible to the customer too)
                          interactions_handoff_enabled:
                            type: boolean
                            description: >-
                              OpenCX routes the handoff itself through Flex
                              Interactions
                          contact_synced_task_attributes:
                            type: array
                            items:
                              type: string
                            description: Task attributes copied onto the contact
                        required:
                          - account_sid
                          - workspace_sid
                          - ai_queue_sid
                          - ai_worker_sids
                          - ai_chat_capacity
                          - ai_worker_email_domain
                          - enabled
                          - internal_notes_enabled
                          - interactions_handoff_enabled
                          - contact_synced_task_attributes
                        additionalProperties: false
                      - type: 'null'
                required:
                  - connected
                  - settings
                additionalProperties: false
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    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.