List Connectors - AiQL Docs

cURL

curl https://api.aiql.io/connectors \
  -H "Authorization: Bearer $AIQL_API_KEY"

[
  {
    "connector_type": "<string>",
    "display_name": "<string>",
    "description": "<string>",
    "connectable": true,
    "category": "",
    "major_category": "",
    "tags": [
      "<string>"
    ],
    "domain": "",
    "icon_fallback": "",
    "icon_color": "",
    "config_fields": [
      {
        "key": "<string>",
        "label": "<string>",
        "type": "<string>",
        "placeholder": "<string>",
        "required": true
      }
    ],
    "auth_type": "form",
    "preview": false,
    "preview_label": "<string>",
    "config_schema": [
      {}
    ],
    "auth": {},
    "supported_formats": [
      "<string>"
    ],
    "supported_operations": [
      "<string>"
    ],
    "example_config": {}
  }
]

{
  "detail": "<string>"
}

GET

/

connectors

cURL

curl https://api.aiql.io/connectors \
  -H "Authorization: Bearer $AIQL_API_KEY"

[
  {
    "connector_type": "<string>",
    "display_name": "<string>",
    "description": "<string>",
    "connectable": true,
    "category": "",
    "major_category": "",
    "tags": [
      "<string>"
    ],
    "domain": "",
    "icon_fallback": "",
    "icon_color": "",
    "config_fields": [
      {
        "key": "<string>",
        "label": "<string>",
        "type": "<string>",
        "placeholder": "<string>",
        "required": true
      }
    ],
    "auth_type": "form",
    "preview": false,
    "preview_label": "<string>",
    "config_schema": [
      {}
    ],
    "auth": {},
    "supported_formats": [
      "<string>"
    ],
    "supported_operations": [
      "<string>"
    ],
    "example_config": {}
  }
]

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

API key or UI session JWT passed as a Bearer token.

Response

Successful Response

connector_type

string

required

Unique identifier of the connector type (matches aiql-ui's marketplace id).

display_name

string

required

Human-readable name of the connector.

description

string

required

One-line summary of what the connector does.

connectable

boolean

required

Whether POST /connectors/{connector_type}/connect currently supports this type end-to-end.

category

string

default:""

Marketplace sub-category, e.g. 'Cloud File Storage'.

major_category

string

default:""

Marketplace top-level grouping, e.g. 'Document Storage'.

tags

string[]

Search/filter tags shown in the marketplace.

domain

string

default:""

Primary domain of the provider (for logo/favicon lookup).

icon_fallback

string

default:""

Two-letter fallback shown when no logo asset exists.

icon_color

string

default:""

Hex color for the fallback icon background.

config_fields

ConnectorConfigField · object[]

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).

Show child attributes

auth_type

string

default:form

Auth flow the UI should use: form | oauth_google | oauth_microsoft | admin_consent_microsoft | api_key_odoo.

preview

boolean

default:false

Whether this connector is in preview/beta.

preview_label

string | null

Label to show next to a preview badge.

config_schema

Config Schema · object[]

aiql-pipeline-connectors' native config schema (populated only when connectable).

auth

Auth · object

aiql-pipeline-connectors' native auth descriptor (populated only when connectable).

supported_formats

string[]

MIME types / data formats this connector can produce.

supported_operations

string[]

Sync operations this connector supports (full_sync, incremental_sync).

example_config

Example Config · object

A minimal valid configuration example.