Sign in

v50

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

Retrieve an Automated Job

Get an automated job by job_id.

get/jobs/automated/{job_id}

Headers

Finch-API-Versionstring date required

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

Response

OK

job_idstring uuid required

The id of the job that has been created.

job_urlstring required

The url that can be used to retrieve the job status

type'data_sync_all' | 'w4_form_employee_sync' required

The type of automated job

status'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error' required
created_atstring date-time required

The datetime when the job was created. for scheduled jobs, this will be the initial connection time. For ad-hoc jobs, this will be the time the creation request was received.

scheduled_atstring date-time nullable required

The datetime a job is scheduled to be run. For scheduled jobs, this datetime can be in the future if the job has not yet been enqueued. For ad-hoc jobs, this field will be null.

started_atstring date-time nullable required

The datetime a job entered into the job queue.

completed_atstring date-time nullable required

The datetime the job completed.