Connector Types API
Retrieve the dynamic registry of all supported connector types.
Endpoints Overview
| Method | Endpoint | Description |
|---|---|---|
| GET | /connector-types | List all connector types |
| GET | /connector-types/{type} | Get type details |
List Connector Types
GET /connector-types
Returns all registered connector types with their UI metadata.
Response
{
"items": [
{
"value": "postgres",
"label": "Scraper - PostgreSQL",
"category": "scraper",
"icon": "🐘",
"description": "Open Source Relational DB",
"form_sections": ["source_system", "credential", "sync_schedule", "sync_config"]
},
{
"value": "quality_postgres",
"label": "Quality - PostgreSQL",
"category": "quality",
"icon": "🐘",
"description": "SQL Quality Checks",
"form_sections": ["source_system", "credential"]
}
]
}
Response Fields
| Field | Type | Description |
|---|---|---|
value | string | Unique type identifier used in API calls |
label | string | Human-readable label |
category | string | Category: scraper, bi, saas, quality, query |
icon | string | Emoji icon for UI display |
description | string | Short description |
form_sections | array | UI form sections displayed when creating a connector |
connection_labels | object | Optional custom labels for connection form fields |
Get Connector Type
GET /connector-types/{type}
Returns metadata for a single connector type.
Response
{
"value": "snowflake",
"label": "Scraper - Snowflake",
"category": "scraper",
"icon": "❄️",
"description": "Cloud Data Platform",
"form_sections": ["source_system", "credential", "sync_schedule", "sync_config"]
}
Returns 404 if the type is not found.
Connector Categories
| Category | Purpose | Example Types |
|---|---|---|
| scraper | Import metadata from data sources | postgres, snowflake, bigquery, dbt, databricks, s3 |
| bi | Scrape BI tool metadata | superset, metabase, looker, tableau, power_bi |
| saas | Connect to SaaS platforms | sfmc, salesforce_crm, zendesk |
| quality | Execute SQL quality checks | quality_postgres, quality_snowflake, quality_bigquery, quality_file |
| query | SQL query execution (Query Editor) | query_postgres, query_snowflake, query_bigquery, query_mysql, query_databricks |
Adding New Connector Types
New connector types are added to the server-side registry. No frontend changes are required — the UI dynamically renders form sections based on the form_sections array. See the Code Standards documentation for implementation details.