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

# List web integrations

> Retrieves all web integrations configured for your organization including
configuration settings and associated tokens.



## OpenAPI

````yaml https://blackbox.dasha.ai/swagger/v1/swagger.json get /api/v1/web-integrations
openapi: 3.0.4
info:
  title: Dasha BlackBox Agent API
  description: API for managing AI agents and calls
  contact:
    name: DashaAI Team
    email: support@dasha.ai
  version: v1
servers:
  - url: https://blackbox.dasha.ai
    description: Dasha BlackBox Agent API
security:
  - ApiKey: []
  - OAuth: []
tags:
  - name: ActivityLogs
  - name: Agents
  - name: CallResults
  - name: Calls
  - name: Chats
  - name: Copilot
  - name: CustomerData
  - name: Mcp
  - name: Media
  - name: Misc
  - name: PronunciationDictionaries
  - name: Providers
  - name: SipAliases
  - name: SipCredentials
  - name: SipPhoneNumbers
  - name: TextChat
  - name: TwilioProvider
  - name: Voice
  - name: WebhookTest
  - name: WebIntegrations
  - name: WebSocket
    description: WebSocket endpoints for real-time communication
paths:
  /api/v1/web-integrations:
    get:
      tags:
        - WebIntegrations
      summary: List web integrations
      description: >-
        Retrieves all web integrations configured for your organization
        including

        configuration settings and associated tokens.
      responses:
        '200':
          description: Returns web integrations successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WebIntegrationResponseDto'
        '401':
          description: Authentication failed or API key is missing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Access denied to web integration resources
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '500':
          description: Server error occurred while retrieving web integrations
components:
  schemas:
    WebIntegrationResponseDto:
      required:
        - agentId
        - createdTime
        - enabled
        - features
        - integrationId
        - lastUpdateTime
        - name
        - orgId
        - tokens
        - widgetAppearance
      type: object
      properties:
        agentId:
          minLength: 1
          type: string
          description: >-
            Agent ID to associate with this web integration. The agent handles
            all conversations initiated through this integration.
        name:
          maxLength: 100
          minLength: 1
          pattern: ^[a-zA-Z0-9\-_ ]+$
          type: string
          description: >-
            Integration name for identification purposes. Allowed characters:
            letters, numbers, hyphens, underscores, and spaces.
        description:
          maxLength: 500
          type: string
          description: Description of the integration's purpose or usage context.
          nullable: true
        origins:
          type: array
          items:
            type: string
          description: >-
            Allowed origins for CORS security. Controls which websites can
            access this integration. If empty or null, all origins are allowed.
            Supported formats: "*" (all origins), full HTTP/HTTPS URLs
            ("https://example.com", "http://localhost:3000"), wildcard
            subdomains ("*.example.com"), or domain names ("example.com"). Ports
            can only be specified in full URLs, not with domain names or
            wildcards.
          nullable: true
        enabled:
          type: boolean
          description: >-
            Whether this integration is active. Disabled integrations cannot be
            used for new conversations.
        tools:
          type: array
          items:
            type: string
          description: >-
            Tool names that should be executed via websocket by the client. When
            the agent needs to use these tools during a conversation, it sends a
            websocketToolRequest message to the client, and the client must
            execute the tool and return the result via websocketToolResponse. If
            not specified, all tools are executed server-side.
          nullable: true
        features:
          type: array
          items:
            $ref: '#/components/schemas/WebIntegrationFeature'
          description: >-
            Enabled features for this integration. Controls capabilities like
            web calls, chat, phone calls, and result delivery.
        widgetAppearance:
          allOf:
            - $ref: '#/components/schemas/WidgetAppearance'
          description: >-
            Widget appearance configuration including theme, position, colors,
            and custom styles for the embedded chat widget.
        integrationId:
          minLength: 1
          type: string
          description: Unique integration identifier
        orgId:
          minLength: 1
          type: string
          description: Organization ID that owns this integration
        createdTime:
          type: string
          description: Integration creation timestamp
          format: date-time
        lastUpdateTime:
          type: string
          description: Last modification timestamp
          format: date-time
        tokens:
          type: array
          items:
            $ref: '#/components/schemas/WebIntegrationTokenDto'
          description: >-
            Access tokens associated with this integration. Tokens are used to
            authenticate websocket connections.
      additionalProperties: false
      description: Web integration response including all configuration and metadata
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
      additionalProperties: {}
    WebIntegrationFeature:
      required:
        - enabled
        - name
      type: object
      properties:
        name:
          allOf:
            - $ref: '#/components/schemas/WebIntegrationFeatureName'
          description: >-
            Feature name identifying the specific capability. Possible values
            include AllowWebCall (WebRTC voice in browser), AllowWebChat (text
            chat), AllowPhoneCall (phone number entry for callback), and
            SendCallResult (deliver conversation outcome to client).
        enabled:
          type: boolean
          description: >-
            Whether this feature is enabled for the integration. When disabled,
            the feature cannot be used even if requested by the client.
      additionalProperties: false
      description: >-
        Individual feature toggle for web integrations. Controls which
        capabilities are enabled for browser-based conversations including web
        calls, web chat, phone calls, and call result delivery.
    WidgetAppearance:
      type: object
      properties:
        theme:
          type: string
          description: >-
            Widget color theme. Supported values are "light" for light
            backgrounds and "dark" for dark backgrounds, allowing the widget to
            match the host website's design.
          nullable: true
        position:
          type: string
          description: >-
            Widget position on the page. Supported values include
            "bottom-right", "bottom-left", "top-right", "top-left",
            "top-center", and "bottom-center" to control where the widget
            appears in the browser viewport.
          nullable: true
        colors:
          type: object
          additionalProperties:
            type: string
          description: >-
            Custom color overrides for widget elements. Keys represent CSS color
            properties and values are color codes in hex, RGB, or other
            CSS-supported formats, allowing brand-specific color customization.
          nullable: true
        customStyles:
          type: object
          additionalProperties: {}
          description: >-
            Custom CSS styles for advanced widget customization. Keys represent
            CSS properties and values can be any valid CSS value, enabling
            complete control over widget appearance beyond the standard theme
            and color options.
          nullable: true
      additionalProperties: false
      description: >-
        Visual customization settings for the embedded web integration widget.
        Controls how the chat widget appears and is positioned in the browser,
        including theme, placement, colors, and custom styling options.
    WebIntegrationTokenDto:
      required:
        - createdAt
        - name
        - token
        - tokenId
      type: object
      properties:
        tokenId:
          minLength: 1
          type: string
          description: Unique token identifier
        name:
          minLength: 1
          type: string
          description: Token name for identification purposes
        token:
          minLength: 1
          type: string
          description: Access token value used to authenticate websocket connections
        createdAt:
          type: string
          description: Token creation timestamp
          format: date-time
        expiresAt:
          type: string
          description: Token expiration timestamp. If null, the token never expires.
          format: date-time
          nullable: true
        lastUsedAt:
          type: string
          description: >-
            Last usage timestamp. Updated when the token is used to establish a
            websocket connection.
          format: date-time
          nullable: true
      additionalProperties: false
      description: Web integration access token information
    WebIntegrationFeatureName:
      enum:
        - AllowWebCall
        - AllowWebChat
        - AllowPhoneCall
        - SendCallResult
        - SendToolCallLogs
        - SendTranscriptForAudioCall
      type: string
      description: Available features for web integrations
  securitySchemes:
    ApiKey:
      type: http
      description: API Key Authentication (Bearer {key})
      scheme: Bearer
    OAuth:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://auth.dasha.ai/connect/authorize
          scopes:
            platform_api: Platform API

````