Skip to main content

This page contains the setup guide and reference information for the source connector.


  • API Key

We recommend creating a restricted key specifically for Airbyte access. This will allow you to control which resources Airbyte should be able to access. For ease of use, we recommend using read permissions for all resources and configuring which resource to replicate in the Airbyte UI.

Setup guide

Step 1: Set up your API Key

  1. Log in to your account.
  2. At the bottom of the left navbar, select Settings.
  3. In the left menu, select Developer.
  4. At the top of the page, click + New API Key.

For security purposes, the API Key will only be displayed once upon creation. Be sure to copy and store the key in a secure location.

For further reading on creating and maintaining API keys, refer to the official documentation.

Step 2: Set up the connector in Airbyte

  1. Log in to your Airbyte Cloud account, or navigate to the Airbyte Open Source dashboard.
  2. From the Airbyte UI, click Sources, then click on + New Source and select from the list of available sources.
  3. Enter a Source name of your choosing.
  4. In the API Key field, enter your API Key
  5. Optional - In the Replication Start Date field, you may enter a starting date cutoff for the data you want to replicate. The format for this date should be as such: YYYY-MM-DD. Leaving this field blank will replicate all data.
  6. Click Set up source and wait for the tests to complete.

Supported sync modes

The source supports both Full Refresh and Incremental syncs. You can choose if this connector will copy only the new/updated data, or all rows in the tables and columns you set up for replication. These settings will take effect every time a sync is run.

Supported streams

This source is capable of syncing the following core streams:


Leads and Events Incremental streams use the date_updated field as a cursor. All other Incremental streams use the date_created field for the same purpose.

The SendAs stream requires payment.

Data type mapping

The API uses the same JSONSchema types that Airbyte uses internally (string, date-time, object, array, boolean, integer, and number), so no type conversions happen as part of this source.

Performance considerations

The connector is subject to rate limits. For more information on this topic, click here.


Config fields reference

Property name


Expand to review
VersionDatePull RequestSubject
0.5.82024-07-1040515Add support for array type custom fields
0.5.72024-07-1041374Update dependencies
0.5.62024-07-0941313Update dependencies
0.5.52024-07-0640994Update dependencies
0.5.42024-06-2540350Update dependencies
0.5.32024-06-2240043Update dependencies
0.5.22024-06-1539477Format source, delete requirements.txt
0.5.12024-05-2038391[autopull] base image + poetry + up_to_date
0.5.02023-11-3032984Add support for custom fields
0.4.32023-10-2831534Fixed Email Activities Stream Pagination
0.4.22023-08-0829206Fixed the issue with DatePicker format for start date
0.4.12023-07-0427950Add human readable titles to API Key and Start Date fields
0.4.02023-06-2727776Update the Email Followup Tasks stream schema
0.3.02023-05-1226024Update the Email sequences stream schema
0.2.22023-05-0525868Added CDK TypeTransformer to gurantee JSON Schema types, added missing properties for roles stream
0.2.12023-02-1523074Specified date formatting in specification
0.2.02022-11-0418968Migrate to Low-Code
0.1.02021-08-105366Initial release of connector for Airbyte