Skip to main content

Harvest

Availability
Available CoreAvailable StandardAvailable PlusAvailable ProAvailable Enterprise FlexAvailable Self-Managed EnterpriseAvailable PyAirbyte
Support Level
Airbyte
Connector Version
1.2.38 (last updated 2 days ago)
Definition ID
fe2b4084-3386-4d3b-9ad6-308f61a6f1e6

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

Prerequisites​

  • A Harvest account.
  • Your Harvest Account ID. You can find it in the Developers section of Harvest ID, listed alongside any Personal Access Tokens you create.
  • One of the following authentication methods:
    • OAuth (recommended for Airbyte Cloud). Airbyte Cloud completes the Harvest OAuth flow for you, so no developer application or tokens are required up front. You authorize the connection from the source setup page.
    • Personal Access Token (recommended for Airbyte Open Source). Create a Personal Access Token from the Developers section of Harvest ID. The token has the all scope and grants access to every Harvest account on your user.

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. For Authentication mechanism, select Authenticate via Harvest (OAuth) from the dropdown, then click Authenticate your Harvest account and authorize the requested account.
  6. Enter your Harvest Account ID.
  7. For Start Date, enter a UTC date and time in YYYY-MM-DDTHH:mm:ssZ format. Data created or updated on and after this date is replicated.
  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. For Authentication mechanism, select Authenticate with Personal Access Token and paste your Personal Access Token.
  6. Enter your Harvest Account ID.
  7. For Start Date, enter a UTC date and time in YYYY-MM-DDTHH:mm:ssZ format. Data created or updated on and after this date is replicated.
  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 Harvest rate limits. Harvest enforces two separate rate limits:

  • General API requests: 100 requests per 15 seconds
  • Reports API requests: 100 requests per 15 minutes

The connector automatically enforces these limits using a built-in HTTP API budget and retries throttled requests using the Retry-After header provided by the API.

You can configure the number of concurrent threads using the Number of Concurrent Threads field. Higher values can speed up syncs but increase API rate limit usage. The default is 4 threads, and the allowed range is 2 to 10. Lower this value when other applications share your Harvest API quota.

Report streams (Expense Reports, Time Reports, Uninvoiced Report, and Project Budget Report) retrieve data in 365-day date windows. For accounts with a long history, initial syncs of these streams may take longer.

Limitations and troubleshooting​

This connector uses Harvest's granular permission model. If your credentials lack access to a specific resource, the corresponding stream produces zero records instead of failing the sync. If a stream returns no data, verify that the Harvest user behind the credentials has the required permissions for that resource.

When authenticating with OAuth, the granted scopes determine which Harvest accounts are reachable through the connection. Personal Access Tokens always have the all scope and reach every Harvest account on your user, while OAuth applications can be limited to a single account, depending on how you registered the application.

Reference​

Config fields reference

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

Changelog​

Expand to review
VersionDatePull RequestSubject
1.2.382026-05-0677821Set Content-Type: application/x-www-form-urlencoded on OAuth access token request
1.2.372026-05-0577778Reorder spec fields so credentials appears before account_id and replication_start_date
1.2.362026-05-0476217Declare OAuth2 flow inline via advanced_auth and oauthConnectorInputSpecification
1.2.352026-04-2875371Update dependencies
1.2.342026-04-2176845Bump SDM base image to stable 7.17.2
1.2.332026-04-1376276Rename "concurrent workers" to "concurrent threads" in connector spec
1.2.322026-04-1076247Promoted release candidate to GA
1.2.32-rc.42026-04-0875543Added configurable concurrency level with num_workers parameter and HTTP API budget rate limiting
1.2.32-rc.12026-03-2475409Test dev image of source-declarative-manifest (7.13.0.post6.dev23497311155)
1.2.312026-03-1074687Update dependencies
1.2.302026-02-2473930Update dependencies
1.2.292026-02-1073113Update dependencies
1.2.282026-02-0372645Update dependencies
1.2.272026-01-2071880Update dependencies
1.2.262026-01-1471693Update dependencies
1.2.252025-12-1870496Update dependencies
1.2.242025-11-2570061Update dependencies
1.2.232025-11-1869372Update dependencies
1.2.222025-10-2968814Update dependencies
1.2.212025-10-2268591Add suggestedStreams
1.2.202025-10-2161157Update dependencies
1.2.192025-10-1466013Update to CDK v7
1.2.182025-05-2460670Update dependencies
1.2.172025-05-1059910Update dependencies
1.2.162025-05-0559215Fix missing schema for time_team, users, time_entries, company, & project_assignments streams.
1.2.152025-05-0359254Update dependencies
1.2.142025-04-2658767Update dependencies
1.2.132025-04-1958170Update dependencies
1.2.122025-04-1257717Update dependencies
1.2.112025-04-0557034Update dependencies
1.2.102025-03-2956653Update dependencies
1.2.92025-03-2256066Update dependencies
1.2.82025-03-0855483Update dependencies
1.2.72025-03-0154796Update dependencies
1.2.62025-02-2254327Update dependencies
1.2.52025-02-1553860Update dependencies
1.2.42025-02-0853282Update dependencies
1.2.32025-02-0152747Update dependencies
1.2.22025-01-2552254Update dependencies
1.2.12025-01-2452139Fix low-code state migration
1.2.02025-01-2352109Make incremental per-partition streams concurrent
1.1.92025-01-1851792Update dependencies
1.1.82025-01-1151155Update dependencies
1.1.72025-01-0450629Update dependencies
1.1.62024-12-2150081Update dependencies
1.1.52024-12-1449634Update dependencies
1.1.42024-12-1249213Update dependencies
1.1.32024-12-1148159Starting with this version, the Docker image is now rootless. Please note that this and future versions will not be compatible with Airbyte versions earlier than 0.64
1.1.22024-10-2947817Update dependencies
1.1.12024-10-2847670Update dependencies
1.1.02024-10-1446898Promoting release candidate 1.1.0-rc1 to a main version.
1.1.0-rc12024-10-0946685Migrate to Manifest-only
1.0.192024-10-0546470Update dependencies
1.0.182024-09-2846143Update dependencies
1.0.172024-09-2145835Update dependencies
1.0.162024-09-1445537Update dependencies
1.0.152024-09-0744986Update dependencies
1.0.142024-08-2444681Update dependencies
1.0.132024-08-1744263Update dependencies
1.0.122024-08-1043463Update dependencies
1.0.112024-08-0343123Update dependencies
1.0.102024-07-2742831Update dependencies
1.0.92024-07-2042326Update dependencies
1.0.82024-07-1341841Update dependencies
1.0.72024-07-1041381Update dependencies
1.0.62024-07-0941303Update dependencies
1.0.52024-07-0641002Update dependencies
1.0.42024-06-2540475Update dependencies
1.0.32024-06-2240169Update dependencies
1.0.22024-05-0838055Fix error handler for retriable errors
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-225071Harvest 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?