List All Connections within a Group

Returns a list of information about all connections within a group in your Fivetran account.

Request schema

Path parameters

groupId

stringrequired

The unique identifier for the group within the Fivetran system.

example:

groupId

Query parameters

schema

string

The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination.

example:

schema_name

cursor

string

Paging cursor, read more about pagination

example:

Iu6zaC1yc2C6tf

limit

integer

Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.

format:

int32

example:

100

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json

example:

application/json

Http + 1.1

GET

https://api.fivetran.com/v1/groups/groupId/connections

GET /v1/groups/groupId/connections?schema=schema_name&cursor=Iu6zaC1yc2C6tf&limit=100 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

items

arrayrequired

The collection of returned items

stringrequired

The unique identifier for the group within the Fivetran system.

example:

connection_id

service

stringrequired

The name for the connector type within the Fivetran system.

example:

google_sheets

schema

stringrequired

The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination.

example:

gsheets.table

paused

booleanrequired

Specifies whether the connection is paused.

status

objectrequired

tasks

array

The collection of tasks for the connection

code

string

Code

example:

resync_table_warning

message

string

Warning message

example:

Resync Table Warning

details

string

warnings

array

The collection of warnings for the connection

code

string

Code

example:

resync_table_warning

message

string

Warning message

example:

Resync Table Warning

details

string

schema_status

string

Schema status. Returned only for connectors that support Universal Column Masking flow.

example:

ready

update_state

stringrequired

The current data update state of the connection. 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.

example:

delayed

setup_state

stringrequired

The current setup state of the connection. The available values are:
- incomplete - the setup config is incomplete, the setup tests never succeeded
- connected - the connection is properly set up
- broken - the connection setup config is broken.

example:

connected

sync_state

stringrequired

The current sync state of the connection. 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.

example:

scheduled

is_historical_sync

booleanrequired

The boolean specifying whether the connection 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 connection 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.

rescheduled_for

string

The scheduled time for the next sync when sync_state is rescheduled. If schedule_type is manual, then the connection expects triggering the event at the designated time through the Sync Connection Data endpoint.

format:

date-time

example:

2024-12-01T15:43:29.013729Z

config

object

The connection setup configuration.

property name *

object

additional property

daily_sync_time

string

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.

example:

14:00

succeeded_at

string

The timestamp of the time the connection sync succeeded last time.

format:

date-time

example:

2024-12-01T15:43:29.013729Z

sync_frequency

integerrequired

The connection sync frequency in minutes

format:

int32

example:

360

group_id

stringrequired

The unique identifier for the group within the Fivetran system.

example:

group_id

connected_by

stringrequired

The unique identifier of the user who has created the connection in your account.

example:

user_id

setup_tests

array

Setup tests results

title

stringrequired

Setup test title

example:

Test Title

status

stringrequired

Setup test status

enum:

"PASSED""SKIPPED""WARNING""FAILED""JOB_FAILED"

message

string

Setup test message

example:

Test Message

details

object

Setup test details

example:

...

source_sync_details

object

The additional information about the connection's state. The format of this parameter is specific for each connector type.

service_version

integer

The connector type version within the Fivetran system.

format:

int32

created_at

stringrequired

The timestamp of when the group was created in your account.

format:

date-time

example:

2024-12-01T15:43:29.013729Z

failed_at

string

The timestamp of the time the connection sync failed last time.

format:

date-time

example:

2024-12-01T15:43:29.013729Z

private_link_id

string

proxy_agent_id

string

networking_method

string

enum:

"Directly""SshTunnel""PrivateLink""ProxyAgent""UnmanagedPrivateLink""UnmanagedProxyAgent""Unknown"

connect_card

object

token

string

The connect-card auth token

example:

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkIjp7ImxvZ2luIjp0cnVlLCJ1c2VyIjoiX2FjY291bnR3b3J0aHkiLCJhY2NvdW50IjoiX21vb25iZWFtX2FjYyIsImdyb3VwIjoiX21vb25iZWFtIiwiY29ubmVjdG9yIjoiY29iYWx0X2VsZXZhdGlvbiIsIm1ldGhvZCI6IlBiZkNhcmQiLCJpZGVudGl0eSI6ZmFsc2V9LCJpYXQiOjE2Njc4MzA2MzZ9.YUMGUbzxW96xsKJLo4bTorqzx8Q19GTrUi3WFRFM8BU

uri

string

The Connect Card URI for the user interface

example:

https://fivetran.com/connect-card/setup?auth=eyJ0eXAiOiJKV1QiLCJh...

pause_after_trial

booleanrequired

Specifies whether the connection should be paused after the free trial period has ended.

data_delay_threshold

integer

format:

int32

data_delay_sensitivity

string

enum:

"LOW""NORMAL""HIGH""CUSTOM"

schedule_type

stringrequired

The connection schedule config type. Supported values: auto, manual. Lets you disable or enable an automatic data sync on a schedule.

example:

auto

local_processing_agent_id

string

connect_card_config

object

redirect_uri

stringrequired

The URI on your site we redirect the end user to after successful setup. The URI must start with the https or http prefix.

example:

https://your.site/path

hide_setup_guide

boolean

An optional parameter that lets you hide the embedded setup guide in the Connect Card.

example:

true

hybrid_deployment_agent_id

string

next_cursor

string

The value of the cursor parameter for the next page

example:

cursor_value

{
  "code": "Success",
  "message": "Operation performed.",
  "data": {
    "items": [
      {
        "id": "connection_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": "FAILED",
            "message": "Test Message",
            "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
        },
        "hybrid_deployment_agent_id": "string"
      }
    ],
    "next_cursor": "cursor_value"
  }
}