Skip to main content
Availability
Available Airbyte CloudAvailable Airbyte OSSAvailable PyAirbyte
Support Level
Community
Latest Version
1.0.0

Freshsales

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

Prerequisites​

  • Freshsales Account
  • Freshsales API Key
  • Freshsales Domain Name

Please read How to find your API key.

Setup guide​

Step 1: Set up the Freshsales connector in Airbyte​

For Airbyte Cloud:​

  1. Log into your Airbyte Cloud account.
  2. In the left navigation bar, click Sources. In the top-right corner, click +new source.
  3. Set the name for your source
  4. Enter your Domain Name
  5. Enter your API Key obtained from these steps
  6. Click Set up source

For Airbyte OSS:​

  1. Navigate to the Airbyte Open Source dashboard
  2. In the left navigation bar, click Sources. In the top-right corner, click +new source.
  3. Set the name for your source
  4. Enter your Domain Name
  5. Enter your API Key obtained from these steps
  6. Click Set up source

Supported sync modes​

FeatureSupported?
Full Refresh SyncYes
Incremental SyncNo
SSL connectionNo
NamespacesNo

Supported Streams​

Several output streams are available from this source:

If there are more endpoints you'd like Airbyte to support, please create an issue.

Performance considerations​

The Freshsales connector should not run into Freshsales API limitations under normal usage. Please create an issue if you see any rate limit issues that are not automatically retried successfully.

Reference​

Config fields reference

Field
Type
Property name
string
domain_name
string
api_key

Changelog​

VersionDatePull RequestSubject
1.0.02023-10-2131685Migrate to Low-Code CDK
0.1.42023-03-2324396Certify to Beta
0.1.32023-03-1624155Set additionalProperties to True in spec to support BC
0.1.22022-07-1400000Tune the get_view_id function
0.1.12021-12-249101Update fields and descriptions
0.1.02021-11-036963🎉 New Source: Freshsales
Was this page helpful?