Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-2148120293.6 KB
Management

Enqueue a New Automated Job

Enqueue an automated job.

data_sync_all: Enqueue a job to re-sync all data for a connection. data_sync_all has a concurrency limit of 1 job at a time per connection. This means that if this endpoint is called while a job is already in progress for this connection, Finch will return the job_id of the job that is currently in progress. Finch allows a fixed window rate limit of 1 forced refresh per hour per connection.

w4_form_employee_sync: Enqueues a job for sync W-4 data for a particular individual, identified by individual_id. This feature is currently in beta.

This endpoint is available for Scale tier customers as an add-on. To request access to this endpoint, please contact your Finch account manager.

post/jobs/automated

Headers

Finch-API-Versionstring date required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Content-Typestring required

Used to indicate the original media type of the resource

Request body

OR

Response

Created

job_idstring uuid

The id of the job that has been created.

job_urlstring

The url that can be used to retrieve the job status

allowed_refreshesinteger required

The number of allowed refreshes per hour (per hour, fixed window)

remaining_refreshesinteger required

The number of remaining refreshes available (per hour, fixed window)

retry_atstring

ISO 8601 timestamp indicating when to retry the request