Getting Started

Account owners have access to the account management section. To access the section, open the top left dropdown menu and click "Manage Account." From here, you can access your "Settings" and scroll down to the "API Config" section to access your account-level API key and secret. You will need these to access your Fivetran account using our API.

API Config

Click Show to see your issued API secret.

Authentication

Fivetran REST API uses API Key authentication. For each request to the API provide an Authorization HTTP header with the following value: Basic {api_key}:{api_secret}. The {api_key}:{api_secret} part should be base64 encoded.

For instance, for API key d9c4511349dd4b86 and API secret 1f6f2d161365888a1943160ccdb8d968, encode d9c4511349dd4b86:1f6f2d161365888a1943160ccdb8d968 to base64 (ZDljNDUxMTM0OWRkNGI4NjoxZjZmMmQxNjEzNjU4ODhhMTk0MzE2MGNjZGI4ZDk2OA==) and use the following Authorization HTTP header value:

Basic ZDljNDUxMTM0OWRkNGI4NjoxZjZmMmQxNjEzNjU4ODhhMTk0MzE2MGNjZGI4ZDk2OA==

Note: The API key is unique for the account and account owner user pair. Different account owners have different API keys.

API secret regeneration

Note: When you regenerate your API secret, your previous API secret will stop working immediately. Make sure that won't affect your system before you generate a new secret.

To generate a new API secret click Generate.

This action will instantly replace your API secret key with a new one.

Response

Every response has the following format:

{
    "code": "Success",
    "message": "User has been invited to the account",
    "data": {
        "id": "cardiac_contemplation",
        "email": "test.user@mycompany.com",
        "given_name": "Test",
        "family_name": "User",
        "verified": false,
        "invited": true,
        "picture": "https://mycompany.com/avatars/test_user.png",
        "phone": "test_phone",
        "logged_in_at": null,
        "created_at": "2019-01-20T16:00:09.097014Z"
   }
}

Fields

Name	Description
`code`	Response status code
`message`	Response status text
`data`	Response data

Common Terms

Term	Description
source	The application, database, storage or event service that creates the data that you are using Fivetran to access in your destination.
connector	The pipeline that you create every time you create a new Fivetran connection from your source to your destination.
connector type	The type of connector that you're creating based on the source. For example, Salesforce is a connector type.
group	Your Fivetran account can have multiple destinations associated with it and we call those groups. Users and connectors can be provisioned within these groups.

Troubleshooting

We respond with standard codes for errors that occur during request processing.

Supported Connectors

Supported through OAuth

These connectors can only be authorized through the Connect Card or the Fivetran dashboard.

We plan to support the remaining connectors soon and will notify you as this list grows.

Custom sync scheduling

You can customize your connector's sync schedule using the Fivetran REST API. With custom scheduling, you can override Fivetran's default sync schedule and only trigger data syncs when you want them. To learn how sync scheduling works at Fivetran, read our sync frequency and scheduling documentation.

To use the REST API to customize your sync schedule, you must change your connector's schedule configuration to manual scheduling. You can then trigger a new sync whenever you want to sync your data.

Manual scheduling

Use the Modify a Connector endpoint to change your connector's schedule_type to manual. This action overrides the standard sync frequency you defined in the Fivetran dashboard, so you will need to manually trigger your syncs after you make this change. Use the example request below to change your connector's schedule_type:

PATCH api.fivetran.com/v1/connectors/{connector_id}

{
    "schedule_type": "manual",
    "run_setup_tests": false
}

Next, use the Sync Connector Data endpoint to trigger a data sync according to your own schedule. Alternatively, you can trigger a sync in your Fivetran dashboard.

Documentation