List All Connectors within a Group
Returns a list of information about all connectors within a group in your Fivetran account.
Request schema
Path parameters
The unique identifier for the group within the Fivetran system.
Query parameters
The name used both as the connector's name within the Fivetran system and as the source schema's name within your destination.
Paging cursor, read more about pagination
Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.
Header parameters
HTTP: basicAuth
HTTP AuthorizationScheme: basic
GET /v1/groups/group_id/connectors?schema=schema_name&cursor=Iu6zaC1yc2C6tf&limit=100 HTTP/1.1
Accept: application/json
Authorization: Basic REPLACE_BASIC_AUTH
Host: api.fivetran.com
Responses
Successful response schema
Response status code
Response status text
The collection of return items
The unique identifier for the group within the Fivetran system.
The name for the connector type within the Fivetran system.
The name used both as the connector's name within the Fivetran system and as the source schema's name within your destination.
Specifies whether the connector is paused.
The collection of tasks for the connector
Code
Warning message
The collection of warnings for the connector
Code
Warning message
Schema status
The current data update state of the connector. The available values are:
- on_schedule - the sync is running smoothly, no delays
- delayed - the data is delayed for a longer time than expected for the update.
The current setup state of the connector. The available values are:
- incomplete - the setup config is incomplete, the setup tests never succeeded
- connected - the connector is properly set up
- broken - the connector setup config is broken.
The current sync state of the connector. The available values are:
- scheduled - the sync is waiting to be run
- syncing - the sync is currently running
- paused - the sync is currently paused
- rescheduled - the sync is waiting until more API calls are available in the source service.
The boolean specifying whether the connector should be triggered to re-sync all historical data. If you set this parameter to TRUE, the next scheduled sync will be historical. If the value is FALSE or not specified, the connector will not re-sync historical data. NOTE: When the value is TRUE, only the next scheduled sync will be historical, all subsequent ones will be incremental. This parameter is set to FALSE once the historical sync is completed.
The scheduled time for the next sync when sync_state is rescheduled. If schedule_type is manual, then the connector expects triggering the event at the designated time through the Sync Connector Data endpoint.
The connector setup configuration.
additional property
The optional parameter that defines the sync start time when the sync frequency is already set or being set by the current request to 1440. It can be specified in one hour increments starting from 00:00 to 23:00. If not specified, we will use the baseline sync start time. This parameter has no effect on the 0 to 60 minutes offset used to determine the actual sync start time.
The timestamp of the time the connector sync succeeded last time.
The connector sync frequency in minutes
The unique identifier for the group within the Fivetran system.
The unique identifier of the user who has created the connector in your account.
Setup tests results
Setup test title
Setup test status
Setup test message
Setup test details.
The additional information about the connector's state. The format of this parameter is specific for each connector type.
The connector type version within the Fivetran system.
The timestamp of when the group was created in your account.
The timestamp of the time the connector sync failed last time.
The connect-card auth token
The Connect Card URI for the user interface
Specifies whether the connector should be paused after the free trial period has ended.
The connector schedule config type. Supported values: auto, manual. Lets you disable or enable an automatic data sync on a schedule.
The URI on your site we redirect the end user to after successful setup. The URI must start with the https or http prefix.
An optional parameter that lets you hide the embedded setup guide in the Connect Card.
The value of the cursor parameter for the next page
{
"code": "Success",
"message": "Operation performed.",
"data": {
"items": [
{
"id": "connector_id",
"service": "string",
"schema": "gsheets.table",
"paused": false,
"status": {
"tasks": [
{
"code": "resync_table_warning",
"message": "Resync Table Warning",
"details": "string"
}
],
"warnings": [
{
"code": "resync_table_warning",
"message": "Resync Table Warning",
"details": "string"
}
],
"schema_status": "ready",
"update_state": "delayed",
"setup_state": "connected",
"sync_state": "scheduled",
"is_historical_sync": false,
"rescheduled_for": "2024-12-01T15:43:29.013729Z"
},
"config": {
"property1": {},
"property2": {}
},
"daily_sync_time": "14:00",
"succeeded_at": "2024-12-01T15:43:29.013729Z",
"sync_frequency": 360,
"group_id": "group_id",
"connected_by": "user_id",
"setup_tests": [
{
"title": "Test Title",
"status": "PASSED",
"message": "Test Passed",
"details": "Test Details"
}
],
"source_sync_details": {},
"service_version": 0,
"created_at": "2024-12-01T15:43:29.013729Z",
"failed_at": "2024-12-01T15:43:29.013729Z",
"private_link_id": "string",
"proxy_agent_id": "string",
"networking_method": "Directly",
"connect_card": {
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkIjp7ImxvZ2luIjp0cnVlLCJ1c2VyIjoiX2FjY291bnR3b3J0aHkiLCJhY2NvdW50IjoiX21vb25iZWFtX2FjYyIsImdyb3VwIjoiX21vb25iZWFtIiwiY29ubmVjdG9yIjoiY29iYWx0X2VsZXZhdGlvbiIsIm1ldGhvZCI6IlBiZkNhcmQiLCJpZGVudGl0eSI6ZmFsc2V9LCJpYXQiOjE2Njc4MzA2MzZ9.YUMGUbzxW96xsKJLo4bTorqzx8Q19GTrUi3WFRFM8BU",
"uri": "https://fivetran.com/connect-card/setup?auth=eyJ0eXAiOiJKV1QiLCJh..."
},
"pause_after_trial": false,
"data_delay_threshold": 0,
"data_delay_sensitivity": "LOW",
"schedule_type": "auto",
"local_processing_agent_id": "string",
"connect_card_config": {
"redirect_uri": "https://your.site/path",
"hide_setup_guide": true
}
}
],
"nextCursor": "cursor_value"
}
}