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

# List Connectors



## OpenAPI

````yaml https://api.aiql.io/openapi.json get /connectors
openapi: 3.1.0
info:
  title: aiql-api
  version: 0.1.0
servers:
  - url: https://api.aiql.io
security: []
tags:
  - name: Health
    description: Service health checks.
  - name: Workspaces
    description: Workspace management.
  - name: Ingestions
    description: Document ingestion pipeline.
  - name: Queries
    description: Natural-language queries.
  - name: Sources
    description: Ingested sources and their contents.
  - name: Requests
    description: Source addition/removal requests awaiting review.
  - name: Request Changes
    description: Individual source add/remove changes on a request.
  - name: Request Reviews
    description: Reviews of a request, including draft and submit.
  - name: Request Comments
    description: Comments on a request review.
  - name: Canvases
    description: Brainstorm canvases.
  - name: Dashboards
    description: Dashboards.
  - name: Presentations
    description: Slide presentations.
  - name: Tools
    description: Standalone convert/split/shape/extract tools.
  - name: Connectors
    description: Connector catalog and connect flows.
  - name: Connections
    description: Workspace connector connections.
paths:
  /connectors:
    get:
      tags:
        - Connectors
      summary: List Connectors
      operationId: list_connectors_connectors_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ConnectorType'
                type: array
                title: Response List Connectors Connectors Get
        '401':
          description: 'Authentication failed: missing or invalid API key.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - HTTPBearer: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl https://api.aiql.io/connectors \
              -H "Authorization: Bearer $AIQL_API_KEY"
components:
  schemas:
    ConnectorType:
      properties:
        connector_type:
          type: string
          title: Connector Type
          description: >-
            Unique identifier of the connector type (matches aiql-ui's
            marketplace id).
        display_name:
          type: string
          title: Display Name
          description: Human-readable name of the connector.
        description:
          type: string
          title: Description
          description: One-line summary of what the connector does.
        category:
          type: string
          title: Category
          description: Marketplace sub-category, e.g. 'Cloud File Storage'.
          default: ''
        major_category:
          type: string
          title: Major Category
          description: Marketplace top-level grouping, e.g. 'Document Storage'.
          default: ''
        tags:
          items:
            type: string
          type: array
          title: Tags
          description: Search/filter tags shown in the marketplace.
        domain:
          type: string
          title: Domain
          description: Primary domain of the provider (for logo/favicon lookup).
          default: ''
        icon_fallback:
          type: string
          title: Icon Fallback
          description: Two-letter fallback shown when no logo asset exists.
          default: ''
        icon_color:
          type: string
          title: Icon Color
          description: Hex color for the fallback icon background.
          default: ''
        config_fields:
          items:
            $ref: '#/components/schemas/ConnectorConfigField'
          type: array
          title: Config Fields
          description: >-
            Form fields the UI should render to collect connection config for
            connector types that use a plain form (empty for OAuth-based and
            Odoo, which use a dedicated flow).
        auth_type:
          type: string
          title: Auth Type
          description: >-
            Auth flow the UI should use: form | oauth_google | oauth_microsoft |
            admin_consent_microsoft | api_key_odoo.
          default: form
        preview:
          type: boolean
          title: Preview
          description: Whether this connector is in preview/beta.
          default: false
        preview_label:
          anyOf:
            - type: string
            - type: 'null'
          title: Preview Label
          description: Label to show next to a preview badge.
        connectable:
          type: boolean
          title: Connectable
          description: >-
            Whether POST /connectors/{connector_type}/connect currently supports
            this type end-to-end.
        config_schema:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Config Schema
          description: >-
            aiql-pipeline-connectors' native config schema (populated only when
            connectable).
        auth:
          additionalProperties: true
          type: object
          title: Auth
          description: >-
            aiql-pipeline-connectors' native auth descriptor (populated only
            when connectable).
        supported_formats:
          items:
            type: string
          type: array
          title: Supported Formats
          description: MIME types / data formats this connector can produce.
        supported_operations:
          items:
            type: string
          type: array
          title: Supported Operations
          description: >-
            Sync operations this connector supports (full_sync,
            incremental_sync).
        example_config:
          additionalProperties: true
          type: object
          title: Example Config
          description: A minimal valid configuration example.
      type: object
      required:
        - connector_type
        - display_name
        - description
        - connectable
      title: ConnectorType
    ErrorResponse:
      type: object
      title: ErrorResponse
      properties:
        detail:
          type: string
          title: Detail
      required:
        - detail
    ConnectorConfigField:
      properties:
        key:
          type: string
          title: Key
          description: Config key the UI should submit for this field.
        label:
          type: string
          title: Label
          description: Human-readable label for the field.
        type:
          type: string
          title: Type
          description: 'Input type: text | password | url | number.'
        placeholder:
          type: string
          title: Placeholder
          description: Placeholder text shown in the input.
        required:
          type: boolean
          title: Required
          description: Whether the field must be filled in.
      type: object
      required:
        - key
        - label
        - type
        - placeholder
        - required
      title: ConnectorConfigField
  securitySchemes:
    HTTPBearer:
      type: http
      description: API key passed as a Bearer token in the Authorization header.
      scheme: bearer

````