Retrieve Quickstart Package Details

The unique identifier for the account within the Fivetran system.

The system ID from the API key. Returned if the system API key is used to authenticate the request.

The user ID from the API key. Returned if the user API key is used to authenticate the request.

The boolean value specifying whether the log service is enabled.

The unique identifier for the group within the Fivetran system

The name of the log service type within the Fivetran system. We support the following log services: `azure_monitor_log`, `cloudwatch`, `datadog_log`, `splunkLog`, `new_relic_log`, `stackdriver` (Google Cloud Logging).

The email address that the user has associated with their user profile.

The group role that you would like to assign this new user to. Supported group roles: ‘Destination Administrator‘, ‘Destination Reviewer‘, ‘Destination Analyst‘, ‘Connector Creator‘, or a custom destination role

The unique identified for the user who has approved the certificate.

Date when certificate has been validated and approved.

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

The boolean value specifying whether a column should be hashed

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

The boolean value specifying whether the enabled property can be updated

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

The reason code indicating the reason why the enabled property cannot be updated: 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

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

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

The Connect Card URI for the user interface

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

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

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 failed last time.

The unique identifier for the group within the Fivetran system.

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

Specifies whether the connector is paused.

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

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

The name for the connector type within the Fivetran system.

The connector type version within the Fivetran system.

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

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

#/components/schemas/textus_ConnectorResponseV1

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

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

The connector daily sync start time that we return only when the sync frequency is set to 1440 (which means 24 hours) and the daily_sync_time parameter was set using the Create a Connector or Update a Connector request

The level of data delay notification threshold. Possible values: LOW, NORMAL, HIGH, CUSTOM. The default value NORMAL. CUSTOM is only available for customers using the [Enterprise plan](https://fivetran.com/docs/getting-started/pricing#fivetranplans) or above.

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

The timestamp of the time the connector sync failed last time

The unique identifier for the hybrid deployment agent within the Fivetran system

The unique identifier for the connector within the Fivetran system

(Deprecated) The unique identifier for the hybrid deployment agent within the Fivetran system

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

Specifies whether the connector is paused

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

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

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

The connector type name within the Fivetran system

The connector type version within the Fivetran system

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

The timestamp of the time the connector sync succeeded last time

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](https://fivetran.com/docs/rest-api/connectors#syncconnectordata) endpoint.

Schema status. Returned only for connectors that support [Universal Column Masking flow](https://fivetran.com/docs/rest-api/tutorials/schema-status).

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 collection of tasks for the connector

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 collection of warnings for the connector

The unique identifier for the dbt Model within the Fivetran system.

Boolean specifying whether the model is selected for execution in the dashboard

The timestamp when dbt project was created.

The unique identifier for the User within the Fivetran system.

The version of dbt that should run the project.

List of environment variables defined as key-value pairs in the raw string format using `=` as a separator. The variable name should have the `DBT_` prefix and can contain A-Z, 0-9, dash, underscore, or dot characters.  Example: `"DBT_VARIABLE=variable_value"`

List of errors occurred while project processing and setup.

Folder in Git repo with your dbt project.

The unique identifier for the Group within the Fivetran system.

Public key to grant Fivetran SSH access to git repository.

Dbt Project Status. Possible values: NOT_READY, ERROR, READY.

Target name to set or override the value from the deployment.yaml.

Project type. Now only `GIT` project type is supported. Default value is `GIT`.

The unique identifier for the dbt Project within the Fivetran system.

Shift my UTC offset with daylight savings time (US Only)

The unique identifier for the destination within the Fivetran system

Data processing location. This is where Fivetran will operate and run computation on data.

The name for the destination type within the Fivetran system.

Determines the time zone for the Fivetran sync schedule.

The set of tables within your database schema config that are synced into the destination

The set of schemas within your connector schema config that are synced into the destination

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

The unique identifier of a feature supported by the connector

Additional information about the feature support of a specific connector

The unique identified for the user who has approved the fingerprint.

Date when fingerprint has been validated and approved.

dbt Project config for Git-based project.

The name of the group within your account.

Boolean, must be true to indicate that the caller accepts the Fivetran On-Prem Software License Addendum.

The unique identifier for the group within your Fivetran account.

The unique ID of a Hybrid Deployment Agent.

Time when this Hybrid Deployment Agent was created.

Base64 encoded content of the config.json

Base64 encoded content of the docker-compose.yaml

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

The connector type name within the Fivetran system.

The unique identifier for the log service within the Fivetran system.

The unique identifier for the user within the Fivetran system.

The role that you would like to assign to the user 

The timestamp that the user created their Fivetran account

Metadata for authorization fields (optional)

The description characterizing the purpose of the connector

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

The connector type identifier within the Fivetran system

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

The connector service name within the Fivetran system

The current availability status of the connector

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

#/components/schemas/textus_NewConnectorRequestV1

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](https://fivetran.com/docs/getting-started/syncoverview#syncfrequencyandscheduling). This parameter has no effect on the [0 to 60 minutes offset](https://fivetran.com/docs/getting-started/syncoverview#syncstarttimesandoffsets) used to determine the actual sync start time

Specifies whether the setup tests should be run automatically. The default value is TRUE.

Specifies whether we should trust the certificate automatically. The default value is FALSE. If a certificate is not trusted automatically, it has to be approved with [Certificates Management API Approve a destination certificate](https://fivetran.com/docs/rest-api/certificates#approveadestinationcertificate).

Specifies whether we should trust the SSH fingerprint automatically. The default value is FALSE. If a fingerprint is not trusted automatically, it has to be approved with [Certificates Management API Approve a destination fingerprint](https://fivetran.com/docs/rest-api/certificates#approveadestinationfingerprint).

Specifies whether setup tests should be run automatically.

The list of unique identifiers for the connections within the Fivetran system.

The id of predefined multi-connector package definition.

The unique identifier for the Quickstart Model within the Fivetran system.

The field indicates whether the Quickstart Transformation is in paused state.

The field indicates whether the tests have been configured for the Quickstart Transformation.

The field indicates whether transformation is in paused state.

The field indicates whether the tests have been configured for dbt Transformation.

The user's avatar as a URL link (for example, 'http://mycompany.com/avatars/john_white.png') or base64 data URI (for example, 'data:image/png;base64,aHR0cDovL215Y29tcGFueS5jb20vYXZhdGFycy9qb2huX3doaXRlLnBuZw==')

The name for the service type within the Fivetran system.

The timestamp of the time the private link was created in your account

The unique identifier for the private link within the Fivetran system.

The unique identifier for the proxy agent within the Fivetran system.

The timestamp of the time the proxy agent was created in your account.

The unique identifier for the connection within the Fivetran system.

Boolean specifying whether the model is selected for execution.

The timestamp when Quickstart Package was created.

The unique identifier for the Quickstart Package within the Fivetran system.

The last time when the Quickstart Transformation has been edited.

The unique identifier of the User within the Fivetran system who last updated the Quickstart Transformation.

The unique identifier for the Quickstart Transformation within the Fivetran system. Quickstart Transformation ids match with the Quickstart Model ids.

The nearest predicted time when this model can start again.

The last time when the Quickstart Transformation selected state has been changed.

The unique identifier of the User within the Fivetran system who last selected or unselected the Quickstart Transformation.

Specifies whether all schemas and tables will be enabled or disabled in the standard config. By specifying the `exclude_mode` parameter value, you can enable or disable syncing for all schemas and tables when reloading the connector schema config. 

When the default `PRESERVE` value is set, all selected schemas and tables in the standard config preserve their state.

When the `EXCLUDE` value is set, the columns that haven't been updated by user yet are not excluded from the sync. Such columns may be present in the source and not displayed in the response, but they are considered to be included in the sync by default. If you enable syncing of their table, then all of these columns from the source will be synced in the next sync cycle. See also [Troubleshooting: How to enable syncs only for the columns you need](https://fivetran.com/docs/rest-api/tutorials/enable-sync-for-columns-you-need).


A map containing an array of tables to re-sync for each schema.

It is an optional parameter that must be non-empty if provided. If not provided, all schemas and tables of the connector are re-synced.


Defines whether the role is standard or custom

Defines the list of resources the role manages

The boolean value specifying whether to enable new schemas, tables, and columns by default

The possible values for the schema_change_handling parameter are as follows: ALLOW_ALL - all new schemas, tables, and columns which appear in the source after the initial setup are included in syncs ALLOW_COLUMNS - all new schemas and tables which appear in the source after the initial setup are excluded from syncs, but new columns are included BLOCK_ALL - all new schemas, tables, and columns which appear in the source after the initial setup are excluded from syncs

If force is true and the connector is currently syncing, it will stop the sync and re-run it. If force is false, the connector will sync only if it isn't currently syncing. The default value is false

The unique identifier for the system key within the Fivetran system

This field appears in the response if the connector supports switching sync modes for tables

The date and time the membership was created

The description of the team within your account

The unique identifier for the team within your account

The timestamp of last dbt Transformation run.

The timestamp of next dbt Transformation run.

The time of the day the transformation should be launched at. The following values are supported: '00:00', '00:30', '01:00', '01:30', '02:00', '02:30', '03:00', '03:30', '04:00', '04:30', '05:00', '05:30', '06:00', '06:30', '07:00', '07:30', '08:00', '08:30', '09:00', '09:30', '10:00', '10:30', '11:00', '11:30', '12:00', '12:30', '13:00', '13:30', '14:00', '14:30', '15:00', '15:30', '16:00', '16:30', '17:00', '17:30', '18:00', '18:30', '19:00', '19:30', '20:00', '20:30', '21:00', '21:30', '22:00', '22:30', '23:00', '23:30'

The unique identifier for the connector within the Fivetran system.

The unique identifier for the destination within the Fivetran system.

The connector authorization settings. Check possible config formats in [create method](/docs/rest-api/api-reference/connectors/create-connector/)

The field indicates if the user is an active Fivetran account user.

The field indicates whether the user has been invited to your account.

The last time that the user has logged into their Fivetran account.

The field indicates whether the user has verified their email address in the account creation process.

Boolean, if set to true, webhooks are immediately sent in response to events.

The secret string used for payload signing.

Your webhooks URL endpoint for your application.

The ID of the user who created the webhook.

Type of event that should be sent for a test.

Returns a Quickstart package details if a valid identifier was provided.

Retrieve Quickstart Package Details

Request schema

Path parameters

Header parameters

Responses

Successful response schema