Skip to main content

Connector Types API

Retrieve the dynamic registry of all supported connector types.

Endpoints Overview

MethodEndpointDescription
GET/connector-typesList 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

FieldTypeDescription
valuestringUnique type identifier used in API calls
labelstringHuman-readable label
categorystringCategory: scraper, bi, saas, quality, query
iconstringEmoji icon for UI display
descriptionstringShort description
form_sectionsarrayUI form sections displayed when creating a connector
connection_labelsobjectOptional 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

CategoryPurposeExample Types
scraperImport metadata from data sourcespostgres, snowflake, bigquery, dbt, databricks, s3
biScrape BI tool metadatasuperset, metabase, looker, tableau, power_bi
saasConnect to SaaS platformssfmc, salesforce_crm, zendesk
qualityExecute SQL quality checksquality_postgres, quality_snowflake, quality_bigquery, quality_file
querySQL 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.