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 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 owner user pair. Different account owners 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.

Postman collectionlink

Postman is a very popular and convenient API client that makes it easy for developers to create, share and test API requests. You can use Fivetran’s ready-made Postman collection to test API endpoints within your account. The collection contains templates to help you create API calls for all endpoints supported by Fivetran.

To use our Postman collection:

1. Download and install Postman.

2. To import the collection, do one of the following:

   • Download and then import our Postman Collection

   

   • Click to automatically import the collection and run it in Postman.

   NOTE: Log in to your Postman account prior to starting the collection import.

   Once the collection is imported, the following API requests will appear on the Collections tab.

   

3. Configure the authorization in Postman.

   i. Hover over the imported Fivetran REST API collection.

   ii. Click the menu icon ( … ).

   iii. Click Edit in the displayed menu. The Edit Collection page opens.

   iv. Select the Variables tab.

   v. Specify your API key and secret in unencoded format in the corresponding Current Value fields. You can find them in your Fivetran account settings. See our REST API documentation to learn how to get your API key and secret. Postman encodes the API key and secret to base64 when calling an endpoint.

   

   IMPORTANT: Don’t share your key and secret. Remember that the exported collection may contain sensitive information in its parameters.

When you complete the collection import and configuration, you will be able to run the API requests. Most of the requests require path or payload parameters that are enclosed in {}. You need to populate the parameters according to your needs.