Retrieve Connection Details

Returns a connection configuration and status details if a valid identifier was provided.

15five

Request schema

Path parameters

connectionId

stringrequired

The unique identifier of the connection. Retrieve it from the id field in the List All Connections response, or from the id field returned when you Create a Connection.

example:

4107c213907114059a5544ad8fa66c52

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json;version=2

example:

application/json;version=2

Http + 1.1

GET

https://api.fivetran.com/v1/connections/4107c213907114059a5544ad8fa66c52

GET /v1/connections/4107c213907114059a5544ad8fa66c52 HTTP/1.1
Accept: application/json;version=2
Authorization: Basic 
Host: api.fivetran.com

Responses

200

Successful response

401

Unauthorized error

404

Not found error

405

Method not allowed error

406

Not acceptable error

`200`

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

Connection details retrieved successfully

data

objectrequired

stringrequired

The unique identifier of this connection. Use this value as the connectionId path parameter when calling other Connections API endpoints, such as Retrieve Connection Details or Sync Connection Data.

example:

connection_id

service

stringrequired

15five

The connector name within the Fivetran system

example:

google_ads

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:

schema.table

paused

booleanrequired

Specifies whether the connection is paused

status

objectrequired

tasks

array

The collection of tasks for the connection

code

string

A machine-readable identifier for the warning type (for example: resync_table_warning). Use this value to programmatically detect and respond to specific connection conditions.

example:

resync_table_warning

message

string

A human-readable label describing the warning. For example: Resync Table Warning.

example:

Resync Table Warning

details

string

warnings

array

The collection of warnings for the connection

code

string

A machine-readable identifier for the warning type (for example: resync_table_warning). Use this value to programmatically detect and respond to specific connection conditions.

example:

resync_table_warning

message

string

A human-readable label describing the warning. For example: Resync Table Warning.

example:

Resync Table Warning

details

string

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

schema_status

string

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

example:

ready

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

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

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, a historical sync starts immediately. If a sync is currently running, it's canceled and restarted as a historical sync. All subsequent syncs after the historical sync completes will be incremental. If the value is FALSE or not specified, the connection doesn't re-sync historical data. This parameter is automatically reset to FALSE once the historical sync is completed.

rescheduled_for

string

The UTC timestamp of the next scheduled sync attempt. Non-null only when sync_state is "rescheduled". If schedule_type is manual, the connection expects the sync to be triggered at the designated time through the Sync Connection Data endpoint.

format:

date-time

example:

2024-12-01T15:43:29.013729Z

group_id

stringrequired

The unique identifier of the destination group this connection belongs to. Use this value with the List All Groups or Retrieve Group Details endpoints.

example:

group_id

service_version

integerrequired

The connector version within the Fivetran system

format:

int32

connected_by

string

The unique identifier of the user who created this connection. null if the connection was created programmatically without a user context. Use this value with the Retrieve User Details endpoint.

example:

priceless_odour

created_at

stringrequired

The timestamp of the time the connection was created in your account

format:

date-time

example:

2023-12-01T15:43:29.013729Z

succeeded_at

string

The UTC timestamp of the most recent successful sync. null if the connection has never completed a successful sync.

format:

date-time

example:

2024-03-17T12:31:40.870504Z

failed_at

string

The UTC timestamp of the most recent failed sync. null if the connection has never experienced a sync failure.

format:

date-time

example:

2024-04-01T18:13:25.043659Z

pause_after_trial

booleanrequired

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

sync_frequency

integerrequired

The connection sync frequency in minutes

format:

int32

enum:

"1""5""15""30""60""120""180""360""480""720""1440"

data_delay_threshold

integer

Custom sync delay notification threshold in minutes. The default value is 0. This parameter is only used when data_delay_sensitivity set to CUSTOM.

format:

int32

data_delay_sensitivity

stringrequired

The level of data delay notification threshold. Possible values: LOW, NORMAL, HIGH, CUSTOM, SYNC_FREQUENCY. The default value NORMAL. CUSTOM is only available for customers using the Enterprise plan or above.

enum:

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

private_link_id

string

The unique identifier for the self-served private link that is used by the connection

example:

link_id

networking_method

string

enum:

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

proxy_agent_id

string

The unique identifier for the proxy agent within the Fivetran system

example:

agent_id

daily_sync_time

string

The daily sync start time, in HH:MM format (UTC), at which the connection syncs. Returned only when sync_frequency is 1440 and daily_sync_time was explicitly set. null otherwise.

example:

14:00

schedule_type

stringrequired

The connection schedule configuration type. Supported values: auto, manual

example:

auto

setup_tests

array

Setup tests results for this connection

title

stringrequired

A human-readable name for the setup test step. For example: Validate Login, Test Connection, Check Permissions.

example:

Validate Login

status

stringrequired

The result of the individual setup test step. Possible values: PASSED, FAILED, SKIPPED.

enum:

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

message

string

The result message for the setup test step. For example: Invalid login credentials.

example:

Invalid login credentials.

details

object

Additional diagnostic information about the setup test result. Populated when the status is FAILED and more context is available beyond the message.

example:

Authentication failed (401 Unauthorized). Verify the provided credentials and permissions.

source_sync_details

object

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

connect_card

object

token

string

A short-lived JWT that authorizes the end user to configure this connection via the Connect Card interface. Use the uri field directly to redirect users — it already embeds this token. If you need to construct your own URL, pass this value as the auth query parameter to https://fivetran.com/connect-card/setup.

example:

eyJ0e...

uri

string

The complete URL to redirect the end user to in order to authorize the connection. It embeds the auth token, redirect URI, and setup guide visibility as query parameters. Redirect the user directly to this address.

example:

https://fivetran.com/connect-card/setup?redirect_uri=https://your.site/path&auth=eyJ0e...&hide_setup_guide=true

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

all_fields

boolean

An optional parameter that lets you show all fields on Connect Card including those that are hidden by default for certain connectors.

example:

true

hybrid_deployment_agent_id

string

The unique identifier for the hybrid deployment agent within the Fivetran system. If not specified, the agent ID from the destination will be used

example:

agent_id

destination_configuration

object

virtual_warehouse

string

Snowflake's virtual warehouse used in the connection

example:

virtual_warehouse

destination_schema_names

string

Defines how schema names appear in your destination.
The possible values are:
- FIVETRAN_NAMING - Uses Fivetran naming conventions to simplify and standardize the schema, table and column names in the destination.
- SOURCE_NAMING - Preserves source schema table and column names in the destination.

enum:

"FIVETRAN_NAMING""SOURCE_NAMING"

config

object

api_key

string

Your 15five API key.

format:

password

example:

your_15five_api_key

{
  "code": "Success",
  "message": "Connection details retrieved successfully",
  "data": {
    "id": "connection_id",
    "service": "15five",
    "schema": "schema.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"
        }
      ],
      "setup_state": "connected",
      "schema_status": "ready",
      "sync_state": "scheduled",
      "update_state": "delayed",
      "is_historical_sync": false,
      "rescheduled_for": "2024-12-01T15:43:29.013729Z"
    },
    "group_id": "group_id",
    "service_version": 0,
    "connected_by": "priceless_odour",
    "created_at": "2023-12-01T15:43:29.013729Z",
    "succeeded_at": "2024-03-17T12:31:40.870504Z",
    "failed_at": "2024-04-01T18:13:25.043659Z",
    "pause_after_trial": false,
    "sync_frequency": 1440,
    "data_delay_threshold": 0,
    "data_delay_sensitivity": "NORMAL",
    "private_link_id": "link_id",
    "networking_method": "Directly",
    "proxy_agent_id": "agent_id",
    "daily_sync_time": "14:00",
    "schedule_type": "auto",
    "setup_tests": [
      {
        "title": "Validate Login",
        "status": "FAILED",
        "message": "Invalid login credentials.",
        "details": "Authentication failed (401 Unauthorized). Verify the provided credentials and permissions."
      }
    ],
    "source_sync_details": {},
    "connect_card": {
      "token": "eyJ0e...",
      "uri": "https://fivetran.com/connect-card/setup?redirect_uri=https://your.site/path&auth=eyJ0e...&hide_setup_guide=true"
    },
    "connect_card_config": {
      "redirect_uri": "https://your.site/path",
      "hide_setup_guide": true,
      "all_fields": true
    },
    "hybrid_deployment_agent_id": "agent_id",
    "destination_configuration": {
      "virtual_warehouse": "virtual_warehouse"
    },
    "destination_schema_names": "FIVETRAN_NAMING",
    "config": {
      "api_key": "your_15five_api_key"
    }
  }
}