Retrieve Source Table Columns Config

Returns the source table columns config for an existing connector within your Fivetran account

Request schema

Path parameters

connectorId

stringrequired

The unique identifier for the connector within the Fivetran system

example:

connector_id

schema

stringrequired

The database schema name within your destination

example:

schema_name

table

stringrequired

The table name within your database schema

example:

table_name

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/connectors/connector_id/schemas/schema_name/tables/table_name/columns

GET /v1/connectors/connector_id/schemas/schema_name/tables/table_name/columns 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

columns

objectrequired

The set of columns within your table schema config that are synced into the destination

property name *

object

additional property

name_in_destination

stringrequired

The schema name within your destination in accordance with Fivetran conventional rules

example:

column_name_in_destination

enabled

booleanrequired

The boolean value specifying whether the sync for the table into the destination is enabled.

example:

true

hashed

booleanrequired

The boolean value specifying whether a column should be hashed

enabled_patch_settings

objectrequired

allowed

booleanrequired

The boolean value specifying whether the enabled property can be modified

reason

string

The additional message indicating the reason why the enabled property cannot be modified. This field appears in the response only when the reason_code value is OTHER

example:

...

reason_code

string

The reason code indicating the reason why the enabled property cannot be modified:
SYSTEM_TABLE - the table is a system table
DELETED - the table was deleted in the source
OTHER - the table was excluded by the system for some reason
This field appears in the response when the allowed property value is FALSE

enum:

"SYSTEM_COLUMN""DELETED""OTHER"

is_primary_key

boolean

{
  "code": "Success",
  "message": "Operation performed.",
  "data": {
    "columns": {
      "property1": {
        "name_in_destination": "column_name_in_destination",
        "enabled": true,
        "hashed": false,
        "enabled_patch_settings": {
          "allowed": false,
          "reason": "...",
          "reason_code": "SYSTEM_COLUMN"
        },
        "is_primary_key": true
      },
      "property2": {
        "name_in_destination": "column_name_in_destination",
        "enabled": true,
        "hashed": false,
        "enabled_patch_settings": {
          "allowed": false,
          "reason": "...",
          "reason_code": "SYSTEM_COLUMN"
        },
        "is_primary_key": true
      }
    }
  }
}