REST API FAQ

Read answers to frequently asked questions about the Fivetran REST API.

---

How can I make sure that connectors created on behalf of my end-users are easily identifiable?

Use a connector naming policy that maintains clear differentiation by customers in a destination. Follow a naming pattern such as {customer_name}_connector_type.

For example, imagine you created a Salesforce connector for your end-user, customer_name = apple. Using this naming policy, you'd name the connector apple-salesforce. This name would appear in the Fivetran dashboard and as the schema name in the destination.

How do I connect to a warehouse using the API?

You can only create a new destination using your Fivetran dashboard. But once you do that, you can easily load new connectors into an existing destination using the .

What is a Connect Card?

Connect Cards let your end users create a connector in your Fivetran account using their own credentials and without logging in. Your users enter their credentials in a Fivetran pop-up window to create and test a new connector. Once the connector setup is complete, you’ll see it in your Fivetran dashboard. You can either manage the connector in your Fivetran dashboard or manage it programmatically using the API. Connect Cards eliminate any credential management or sharing between you and your end users.

Can I customize the look and feel of the Connect Card?

You can't customize the end-user experience in the redirect URL. However, everything up until then is your own. We expect that the end-user will interact with the Connect Card for approximately 30 seconds to 5 minutes, depending on the connector type.

Can I put Connect Card in an iframe?

No, because iframes pose security risks, such as clickjacking. We deny opening fivetran.com in iframes by setting the header to x-frame-options: SAMEORIGIN.

Can I apply a custom schema to a connector using Connect Card?

Yes. First, set up a for your connector. Next, use the to review the schema for that connector. Finally, use the to adjust the inclusion of schemas, tables, and columns as the connector permits.

If you want to give your end user more control, you can also use the same endpoints to build data selection into your user interface.

Can I customize my connector's sync schedule using the REST API?

Yes. Learn how in our .

Can I create a new connector based on an existing connector's parameters?

Yes. See our .

How can I embed a Function connector?

We do not recommend using Connect Card with our Function connectors. Instead, set up functions using the API. You can reuse a function that you've created and create a new connector for each end-user. Then, share the relevant authentication information via the . For example, for , you'd have your end-user share the "secrets" that are relevant to the function that you created.

How can I set up Powered by Fivetran to embed data pipelines into my product?

Read our or and to learn everything you need to get started with PBF.

How do I access the Fivetran REST API?

Learn how in our .

Can I interact with Fivetran REST API using Python?

Yes. Learn how in our .

How can I run a manual sync and poll for completion using the REST API?

Learn how in our .

How do I back up a connector’s schema?

Learn how in our .

How do I find the Connector ID?

Learn how in our .

Can I set up connectors programmatically?

Yes. Learn how in our .

Why is the Fivetran API refusing my connection requests?

Learn why in our .

What does the exclude_mode Parameter Do?

Learn about this parameter in .