Getting Started

Account Administrators in Standard Select, Standard, Enterprise, and Business Critical accounts can manage the API configuration settings on the account management page. To access the API configuration settings:

1. Open the top left dropdown menu and click Manage Account.
2. Go to the Settings tab and scroll down to the API Config section to access your user-level API key and secret.

You will need these to access your Fivetran account using our API.

Click Generate to generate a new API key and secret. Make a note of the API key and API secret.

NOTE: You can generate the API key and secret if we have not issued them. Click Generate new secret, to generate a new API secret and replace the existing secret.

Authenticationlink

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 Administrator user pair. Different Account Administrators have different API keys.

API secret regenerationlink

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 new secret.

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

Request content typelink

Fivetran Public API only accepts requests with the Content-Type: application/json header explicitly specified in them. Make sure you have this header specified in the request when sending the POST and PATCH requests.

Responselink

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"
   }
}

Common termslink

Troubleshootinglink

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

Connectors supported by API and their authorization methodslink

The following table lists the connectors supported by Fivetran’s REST API as well as supported authorization methods. You can use the following authorization methods:

• Connect Card
• various authorization methods using the API:
  • by defining the auth section in the API request
  • by providing the credentials using the login and password fields in the API request
  • by providing the credentials using the token field and related field(s) in the API request
  • by providing the credentials using the key field and related field(s) in the API request

NOTE: If you’d like Fivetran’s REST API to support a connector that’s not listed here, submit your request in our Support Portal.