Getting Started

Scoped API Key

The Scoped API key and secret you create as a Fivetran user allow you to use our REST API. The key and secret pair is linked to you and is scoped to your RBAC permissions. You cannot create service account keys.

Prerequisites

To use this feature, you need a Fivetran account on a Standard, Enterprise, or Business Critical plan.

Instructions

1. Click your user name in your Fivetran dashboard.

2. Click API Key.

3. Click Generate API key.

   If you already have an API key, then the button text is Generate new API key.

   

4. Make a note of the key and secret as they won't be displayed once you close the page or navigate away. You will need these to access your Fivetran account using our API.

Scoped API Key FAQs

Read answers to frequently asked questions about our scoped API keys.

System API Key

System Keys are meant to replace user-oriented, scoped API keys. Instead of relying on RBAC to scope permissions, you set permission at the key level and manage them centrally. This solves for key pain points in securely managing keys, allowing you to understand usage, rotation, and other key information.

See our System Keys documentation for more details.

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}. Basic authentication requires the key and secret to be base64-encoded. You can utilize the -u flag for curl:

curl -u api_key:api_secret "https://example.com"

or you can encode to base64 by running one of following commands in CLI (depending on your environment):

• On Linux/macOS:

  echo -n '<API Key>:<Secret Key>' | base64
  

• On Linux/macOS (using OpenSSL):

  echo -n '<API Key>:<Secret Key>' | openssl base64
  

• On Windows (Command Prompt with OpenSSL installed):

  echo "<API Key>:<Secret Key>" | openssl base64
  

• On Windows (PowerShell):

  [Convert]::ToBase64String([Text.Encoding]::UTF8.GetBytes("<API Key>:<Secret Key>"))
  

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

Basic ZDljNDUxMTM0OWRkNGI4NjoxZjZmMmQxNjEzNjU4ODhhMTk0MzE2MGNjZGI4ZDk2OA==

API secret regeneration

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 type

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.

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

The timestamp format is specified as "yyyy-MM-dd'T'HH:mm:ss.SSSSSS'Z'".

Fields

Common terms

Troubleshooting

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

Connectors supported by API and their authorization methods

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

| Sentry | check | check | | Service Now | check | check | | ServiceTitan | check | check | | SFTP | check | check | | ShareASale | check | check | | SharePoint | check | check | | Sharetribe | check | check | | ShipHero | check | check | | ShipNetwork | check | check | | ShipStation | check | check | | Shopify | check | check | | Shopware | check | check | | Short.io | check | check | | Shortcut | check | check | | Showpad | check | check | Sigma Computing | check | check | | Simplecast | check | check | | Simplesat | check | check | | SingleStore | check | check | | SISTRIX | check | check | | Skilljar | check | check |
| SkillsTX | check | check |
| Skimlinks | check | check |
| SkuVault | check | check | | Slack | check | check | | Slab | check | check | | Smadex | check | check | | SmartHR | check | check | | SmartRecruiters | check | check | | Smartwaiver | check | check | | Snapchat Ads | check | check | | Snowplow | check | | | Snyk | check | check | | SolarWinds Service Desk | check | check | | SonarQube | check | | | SparkPost | check | check | | Splash | check | check | | Split | check | check | | Splunk | check | check | | Spotify Ads | check | check | | Sprout Social | check | check | | SQL Server | check | check | | Square | check | check |
| StackAdapt | check | check | | Standard Metrics | check | check | | StarRez | check | check | | Statistics Netherlands CBS | check | check | | Statsig | check | check | | Statuspage | check | check | | sticky.io | check | check | | Stripe | check | check | | Stylight | check | check | | Subscript | check | check | | SugarCRM | check | check | | SurveyMonkey | check | check | | Survicate | check | check | | Swoogo | check | check | | Tableau | check | check | | Taboola | check | check | | Talkdesk | check | check | | Talkwalker | check | check | | Teads | check | check | | Teamtailor | check | check | | Teamwork | check | check | | Tempo | check | check | | TestRail | check | check | | TextUS | check | check | | The Movie Database | check | check | | The Trade Desk | check | check | | Thinkific | check | check | | Ticket Tailor | check | check | | TikTok Ads | check | check | | TikTok Organic | check | check | | Tive | check | check | | Toggl Track | check | check | | Totango | check | check | | Transcend | check | check | | Trelica | check | check | | Trello | check | check | | Tremendous | check | check | | Triple Whale | check | check | | Trisolute | check | check | | Twilio | check | check | | Twitter Organic | check | check | | Twitter Ads | check | check | | Typeform | check | check | | Tymeshift | check | check | | Udemy Business | check | check | | UKG Pro | check | check | | UKG Pro Workforce Management | check | check | | Unicommerce | check | check | | Upland Software | check | check | | UpPromote | check | check | | UserVoice | check | check | | Validio | check | check | | Veeqo | check | check | | Veeva Vault | check | check | | Venminder | check | check | | Vimeo | check | check | | Visit by GES | check | check | | Visma | check | check | | Vitally | check | check | | Vonage Contact Center | check | check | | VTS | check | check | | VWO | check | check | | Walmart DSP | check | check | | Walmart Marketplace | check | check | | Webconnex | check | check | | Webhooks | check | check | | When I Work | check | check | | Wherefour | check | check | | Wicked Reports | check | check | | WooCommerce | check | check | | WordPress | check | check | | Workable | check | check | | Workday Financial Management | check | check | | Workday HCM | check | check | | Workday RaaS | check | check | | Workday Strategic Sourcing | check | check | | Workleap Officevibe | check | check | | WorkRamp | check | check | | Wrike | check | check | | Xactly | check | check | | Xandr | check | check | | Xero | check | | | Xray | check | check | | Xsolla | check | check | | Yahoo Display Ads on Yahoo Japan | check | check | | Yahoo DSP | check | check | | Yahoo Search Ads on Yahoo Japan | check | check | | Yext | check | check | | Yotpo | check | check | | YouGov Sport | check | check | | Younium | check | check | | YouTube Analytics | check | check | | Zendesk Chat | check | check | | Zendesk Sell | check | check | | Zendesk Sunshine | check | check | | Zendesk Support | check | check | | Zenefits | check | check | | Zingtree | check | check | | Zip | check | check | | Zoho Books | check | check | | Zoho Campaigns | check | check | | Zoho CRM | check | check | | Zoho Desk | check | check | | Zoho Inventory | check | check | | Zoho Recruit | check | check | | Zonka Feedback | check | check | | Zoom | check | check | | Zuora | check | check |