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

# List Connector Types

> Discover supported connector types and the fields each requires



## OpenAPI

````yaml GET /v2/connectors/types
openapi: 3.1.0
info:
  title: TextQL v2 API
  version: '2.0'
  description: >
    REST API for TextQL platform operations. All endpoints require Bearer token
    authentication.
servers:
  - url: https://app.textql.com
security:
  - bearerAuth: []
tags:
  - name: Chat
    description: Create and manage AI chat sessions
  - name: Connectors
    description: List available data connectors
  - name: Playbooks
    description: Create, configure, and run automated playbooks
  - name: Sandcastles
    description: Manage Python sandbox environments for code execution
  - name: Changes
    description: Review, approve, and deny Ontology changes
  - name: API Keys
    description: Mint and revoke scoped platform API keys
paths:
  /v2/connectors/types:
    get:
      tags:
        - Connectors
      summary: List Connector Types
      description: |
        Enumerate every supported connector type and the fields each requires,
        so you can build a valid `config` without reading the proto. For each
        type, `connector_type` is the value to set as `config.connector_type`
        and `config_key` is the metadata object to nest under `config`.

        Fields flagged `confidential` are write-only (passwords, keys, tokens) —
        they are never returned by read endpoints, and when `optional_on_update`
        is true they may be omitted on `PATCH` to preserve the stored value.
      operationId: v2.listConnectorTypes
      responses:
        '200':
          description: Supported connector types and their field schemas
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListConnectorTypesResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    ListConnectorTypesResponse:
      type: object
      required:
        - types
      properties:
        types:
          type: array
          items:
            $ref: '#/components/schemas/ConnectorTypeInfo'
    ConnectorTypeInfo:
      type: object
      description: A supported connector type and the shape of its config.
      properties:
        connector_type:
          type: string
          description: Value to set as config.connector_type (e.g. `KDB`).
        config_key:
          type: string
          description: Metadata object key to nest under config (e.g. `kdb`).
        fields:
          type: array
          items:
            $ref: '#/components/schemas/ConnectorTypeField'
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable error code
              enum:
                - invalid_request
                - unauthenticated
                - permission_denied
                - not_found
                - conflict
                - rate_limit_exceeded
                - internal
                - timeout
                - cancelled
                - execution_failed
                - no_report
            message:
              type: string
              description: Human-readable error message
    ConnectorTypeField:
      type: object
      description: One configurable field of a connector type.
      properties:
        name:
          type: string
        type:
          type: string
          description: 'JSON-friendly type: string, number, boolean, array, or object.'
        confidential:
          type: boolean
          description: >-
            Write-only field (password/key/token); never returned by read
            endpoints.
        optional_on_update:
          type: boolean
          description: May be omitted on PATCH to preserve the stored value.
  responses:
    Unauthorized:
      description: Missing or invalid authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: unauthenticated
              message: Authentication required
    Forbidden:
      description: Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: permission_denied
              message: Insufficient permissions
    RateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: rate_limit_exceeded
              message: Rate limit exceeded
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: internal
              message: Internal server error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or JWT token

````