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:
- Open the top left dropdown menu and click Manage Account.
- 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"
}
}
Fields
Name | Description |
---|---|
code |
Response status code |
message |
Response status text |
data |
Response data |
Common termslink
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. |
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
andpassword
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
- by defining the
Connector | Connect Card | API Authorization |
---|---|---|
Adjust | check | check |
Adobe Analytics | check | |
Adobe Analytics Data Feed | check | check |
ADP Workforce Now | check | check |
AdRoll | check | check |
Airtable | check | check |
Amazon Ads | check | check |
Amazon S3 | check | check |
Amplitude | check | check |
Anaplan | check | check |
Apache Kafka | check | check |
Apple App Store | check | |
Apple Search Ads | check | check |
AppsFlyer | check | check |
Asana | check | check |
AWS CloudTrail | check | check |
AWS Inventory | check | check |
AWS Lambda | check | check |
AWS MSK | check | check |
Azure Blob Storage | check | check |
Azure Functions | check | check |
Azure Event Hubs | check | check |
Box | check | check |
Braintree | check | check |
Branch | Authorization not required | Authorization not required |
Braze | check | check |
Amazon CloudFront | check | check |
Confluent Cloud | check | check |
Coupa | check | check |
Criteo | check | check |
Delighted | check | check |
Dropbox | check | check |
DynamoDB | check | check |
Eloqua | check | |
check | check | |
Facebook Ad Account | check | |
Facebook Ad Insights | check | |
Facebook Ads | check | check |
Facebook Pages | check | check |
FinancialForce | check | check |
Fivetran Log Connector | check | check |
Freshdesk | check | check |
Front | check | check |
FTP/FTPS | check | check |
Gainsight Customer Success | check | check |
GitHub | check | check |
Google Ad Manager | check | check |
Google Ads | check | check |
Google Analytics | check | check |
Google Analytics 4 | check | check |
Google Analytics 4 Export | check | check |
Google Analytics 360 | check | check |
Google Analytics (MCF) | check | check |
Google Campaign Manager 360 | check | check |
Google Cloud Functions | check | check |
Google Cloud Storage | check | check |
Google Display & Video 360 | check | check |
Google Drive | check | |
Google Play | check | check |
Google Search Console | check | check |
Google Sheets | check | check |
Greenhouse | check | check |
Heap | check | check |
Height | check | check |
Help Scout | check | check |
Heroku Kafka | check | check |
HubSpot | check | |
Instagram Business | check | check |
Intercom | check | |
Iterable | check | check |
Jira | check | check |
Kinesis | check | check |
Klaviyo | check | check |
Kustomer | check | check |
Lever | check | check |
Lightspeed Retail | check | |
LinkedIn Ad Analytics | check | check |
LinkedIn Company Pages | check | check |
Mailchimp | check | |
Mandrill | check | check |
MariaDB | check | check |
Marin Software | check | check |
Marketo | check | check |
Mavenlink | check | |
Microsoft Advertising | check | check |
Microsoft Dynamics 365 | check | check |
Microsoft Dynamics 365 F/O | check | check |
Microsoft Lists | check | check |
Mixpanel | check | check |
MongoDB | check | check |
MySQL | check | check |
NetSuite SuiteAnalytics | check | check |
Optimizely | check | check |
Oracle | check | check |
Oracle Fusion Cloud Applications | check | check |
Outbrain | check | check |
Outreach | check | check |
Pardot | check | check |
Pendo | check | check |
Pinterest Ads | check | check |
Pipedrive | check | check |
PostgreSQL | check | check |
Qualtrics | check | check |
QuickBooks | check | check |
ReCharge | check | check |
Recurly | check | check |
Sage Intacct | check | check |
Sailthru | check | check |
Salesforce | check | check |
Salesforce Marketing Cloud | check | check |
SAP Business ByDesign | check | check |
SAP Concur | check | check |
SAP HANA | check | check |
SAP S/4 | check | check |
Segment | check | check |
Sendgrid | check | check |
Service Now | check | check |
SFTP | check | check |
SharePoint | check | check |
Shopify | check | check |
Snapchat Ads | check | check |
Snowplow | check | |
Splunk | check | check |
SQL Server | check | check |
Square | check | check |
Stripe | check | check |
SurveyMonkey | check | check |
Taboola | check | check |
The Trade Desk | check | check |
TikTok Ads | check | check |
Twilio | check | check |
Twitter Organic | check | check |
Twitter Ads | check | check |
Typeform | check | check |
UserVoice | check | check |
Verizon Media | check | check |
Webhooks | check | check |
Workday | check | check |
Workday HCM | check | check |
Xero | check | |
YouTube Analytics | check | check |
Zendesk Chat | check | check |
Zendesk Sell | check | check |
Zendesk Sunshine | check | check |
Zendesk Support | check | check |
Zoho CRM | check | check |
Zuora | check | check |
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.