Skip to main content
Availability
Available Airbyte CloudAvailable Airbyte OSSAvailable PyAirbyte
Support Level
Certified
Latest Version
1.0.1

Harvest

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

Prerequisites​

To set up the Harvest source connector, you'll need the Harvest Account ID and API key.

Setup guide​

For Airbyte Cloud:

  1. Log into your Airbyte Cloud.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select Harvest from the Source type dropdown.
  4. Enter the name for the Harvest connector.
  5. Enter your Harvest Account ID.
  6. For Start Date, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated.
  7. For Authentication mechanism, select Authenticate via Harvest (OAuth) from the dropdown and click Authenticate your Harvest account. Log in and authorize your Harvest account.
  8. Click Set up source.

For Airbyte Open Source:

  1. Navigate to the Airbyte Open Source dashboard.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select Harvest from the Source type dropdown.
  4. Enter the name for the Harvest connector.
  5. Enter your Harvest Account ID.
  6. For Start Date, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated.
  7. For Authentication mechanism, select Authenticate with Personal Access Token from the dropdown. Enter your Personal Access Token.
  8. Click Set up source.

Supported sync modes​

The Harvest source connector supports the following sync modes:

Supported Streams​

Performance considerations​

The connector is restricted by the Harvest rate limits.

Reference​

Config fields reference

Field
Type
Property name
string
account_id
string
replication_start_date
string
replication_end_date
object
credentials

Changelog​

VersionDatePull RequestSubject
1.0.12024-04-2436641Schema descriptions and CDK 0.80.0
1.0.02024-04-1535863Migrates connector to Low Code CDK, Updates incremental substream state to per-partition state
0.2.02024-04-0836889Unpin CDK version
0.1.242024-02-2635541Improve check command to avoid missing alerts
0.1.232024-02-1935305Fix pendulum parsing error
0.1.222024-02-1235154Manage dependencies with Poetry.
0.1.212023-11-3033003Update expected records
0.1.202023-10-1931599Base image migration: remove Dockerfile and use the python-connector-base image
0.1.192023-07-2628755Changed parameters for Time Reports to use 365 days as opposed to 1 year
0.1.182023-05-2926714Remove authSpecification from spec in favour of advancedAuth
0.1.172023-03-0322983Specified date formatting in specification
0.1.162023-02-0722417Turn on default HttpAvailabilityStrategy
0.1.152023-01-2722008Set AvailabilityStrategy for streams explicitly to None
0.1.142023-01-0921151Skip 403 FORBIDDEN for all stream
0.1.132022-12-2220810Skip 403 FORBIDDEN for EstimateItemCategories stream
0.1.122022-12-1620572Introduce replication end date
0.1.112022-09-2817326Migrate to per-stream states.
0.1.102022-08-0815221Added parent_id for all streams which have parent stream
0.1.92022-08-0415312Fix started_time and ended_time format schema error and updated report slicing
0.1.82021-12-148429Update titles and descriptions
0.1.62021-11-147952Implement OAuth 2.0 support
0.1.52021-09-285747Update schema date-time fields
0.1.42021-06-225701Harvest normalization failure: fixing the schemas
0.1.32021-06-224274Fix wrong data type on statement_key in clients stream
0.1.22021-06-074222Correct specification parameter name
0.1.12021-06-093973Add AIRBYTE_ENTRYPOINT for Kubernetes support
0.1.02021-06-073709Release Harvest connector!
Was this page helpful?