Retrieve source metadata public endpoint

Returns all available source types. This endpoint provides metadata including the proper source name (‘Facebook Ads’ instead of facebook_ads), the source icon, feature tables, information about the Hybrid deployment support, information about the Authorization via API support, and links to Fivetran resources. As we update source names and icons, that metadata will automatically update within this endpoint.

Request schema

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json

example:

application/json

Http + 1.1

GET

https://api.fivetran.com/public/connector-types

GET /public/connector-types HTTP/1.1
Accept: application/json
Authorization: Basic REPLACE_BASIC_AUTH
Host: api.fivetran.com

Responses

200

Successful response

Successful response schema

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

Operation performed.

data

objectrequired

stringrequired

The connector type identifier within the Fivetran system

example:

google_ads

name

stringrequired

The connector service name within the Fivetran system

example:

Google Ads

type

stringrequired

The connector service type

enum:

"API""Dbt""Marketing""HumanResources""Finance""Productivity""Engineering""Support""Sales""Security""SuperConnectorTest""Free""File""Database""Events""Function""BITool""Warehouse""Log""Hvr"

description

string

The description characterizing the purpose of the connector

example:

Google Ads is an online advertising platform

icons

array

The set of additional icon resource URLs in different formats (.svg, .png). Updating this list is not a breaking change. The set of icon URLs or the icons themselves may be changed

type:

string

config

object

Metadata for configuration fields

auth

object

Metadata for authorization fields (optional)

service_status_updated_at

string

The date (yyyy-MM-dd) the connector status was updated to the current availability status

format:

date-time

supported_features

array

string

The unique identifier of a feature supported by the connector

enum:

"CUSTOM_DATA""CAPTURE_DELETES""DATA_BLOCKING""COLUMN_HASHING""RE_SYNC""HISTORY""API_CONFIGURABLE""PRIORITY_FIRST_SYNC""FIVETRAN_DATA_MODELS""PRIVATE_NETWORKING""AUTHORIZATION_VIA_API"

notes

string

Additional information about the feature support of a specific connector

example:

...

link_to_docs

string

The link to the connector documentation

example:

https://fivetran.com/docs/connectors/applications/google-ads

connector_class

string

enum:

"standard""lite""partner-built"

link_to_erd

string

The link to the connector ERD (entity–relationship diagram)

example:

https://docs.google.com/presentation/d/1f16zOPxwT1AXoOcNkvwT82ApKqU1yhtJ04f-73M91nw/embed

service_status

string

The current availability status of the connector

enum:

"general_availability""beta""private_preview""sunset""development"

icon_url

string

The icon resource URL

example:

https://fivetran.com/integrations/google_ads/resources/google-ads.png

{
  "code": "Success",
  "message": "Operation performed.",
  "data": {
    "id": "google_ads",
    "name": "Google Ads",
    "type": "Marketing",
    "description": "Google Ads is an online advertising platform",
    "icons": [
      "string"
    ],
    "config": {},
    "auth": {},
    "service_status_updated_at": "2019-08-24T14:15:22Z",
    "supported_features": [
      {
        "id": "API_CONFIGURABLE",
        "notes": "..."
      }
    ],
    "link_to_docs": "https://fivetran.com/docs/connectors/applications/google-ads",
    "connector_class": "standard",
    "link_to_erd": "https://docs.google.com/presentation/d/1f16zOPxwT1AXoOcNkvwT82ApKqU1yhtJ04f-73M91nw/embed",
    "service_status": "general_availability",
    "icon_url": "https://fivetran.com/integrations/google_ads/resources/google-ads.png"
  }
}