Connector Metadata
Represents the metadata for a Fivetran connector. The connector metadata resource provides static information about a connector's identity, capabilities, and configuration schema. It is useful for discovering available connectors and understanding their supported features before creating a connection.
Resource attributes
The following attributes describe a connector and its capabilities.
Connector metadata attributes
| Field name | Type | Description |
|---|---|---|
id | string, read-only | Unique identifier of the connector within the Fivetran system. Example: google_ads. |
name | string, read-only | Public name of the connector. Example: Google Ads. |
type | string, read-only | Category of the connector. Example: Marketing. |
description | string, read-only | A short description of the connector's purpose. |
icon_url | string, read-only | URL of the connector's icon image. |
icons | array of strings, read-only | Set of icon URLs in multiple formats (PNG and SVG). |
link_to_docs | string, read-only | URL to the connector's documentation page. |
link_to_erd | string, read-only | URL to the connector's entity-relationship diagram. Empty if not applicable. |
connector_class | string, read-only | Indicates whether the connector is a full or limited implementation. Possible values:standard – Full connector with complete schema and sync coverage.lite – Limited connector with partial schema coverage. |
service_status | string, read-only | Availability status of the connector. Possible values:general_availability – Available to all customers.beta – Available but still in beta.private_preview – Available to select customers only.development – Not yet available.sunset – No longer available. |
service_status_updated_at | string, read-only | Date the connector's availability status was last updated, in yyyy-MM-dd format. |
supported_features | array of objects, read-only | List of features supported by the connector. See Feature attributes. |
config | object, read-only | JSON schema describing the connector's configuration fields. |
auth | object, read-only | JSON schema describing the connector's authorization fields. Omitted if not applicable. |
Feature attributes
These attributes describe an individual entry in the supported_features array.
| Field name | Type | Description |
|---|---|---|
id | string, read-only | Identifier of the supported feature. Possible values:CUSTOM_DATA – Connector supports custom data ingestion.CAPTURE_DELETES – Connector can detect and replicate deleted rows.DATA_BLOCKING – Connector supports schema and table blocking.COLUMN_HASHING – Connector supports column-level hashing.RE_SYNC – Connector supports manual re-sync.HISTORY – Connector supports historical sync mode.API_CONFIGURABLE – Connector can be fully configured via API.PRIORITY_FIRST_SYNC – Connector supports prioritized initial sync.FIVETRAN_DATA_MODELS – Connector provides Fivetran-managed data models.PRIVATE_NETWORKING – Connector supports private networking.AUTHORIZATION_VIA_API – Connector supports API-based authorization.ROW_FILTERING – Connector supports row-level filtering. |
notes | string, read-only | Additional details about the feature's support for this specific connector. |
Supported operations
| Category | Endpoint | Description |
|---|---|---|
| List | GET /v1/metadata/connector-types | Returns a paginated list of all connector types and their metadata. |
| Retrieve | GET /v1/metadata/connector-types/{service} | Returns the metadata for a specific connector type, including its full configuration schema. |