GET
/
jobs
/
automated
/
{job_id}
import Finch from '@tryfinch/finch-api';

const finch = new Finch();

async function main() {
  const automatedAsyncJob = await finch.jobs.automated.retrieve('string');

  console.log(automatedAsyncJob.job_id);
}

main();
{
  "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
  "job_url": "https://api.tryfinch.com/job/automated/453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
  "type": "data_sync_all",
  "status": "pending",
  "created_at": "2019-08-24T14:15:22Z",
  "scheduled_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}

Authorizations

Authorization
string
headerrequired

Please use your Access Token

Headers

Finch-API-Version
string
default: 2020-09-17required

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

Content-Type
string
default: application/jsonrequired

Used to indicate the original media type of the resource

Path Parameters

job_id
string
required

Response

200 - application/json
job_id
string

The id of the job that has been created.

job_url
string

The url that can be used to retrieve the job status

type
enum<string>

Only data_sync_all currently supported

Available options:
data_sync_all
status
enum<string>
Available options:
pending,
in_progress,
complete,
error,
reauth_error,
permissions_error
created_at
string

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_at
string | null

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_at
string | null

The datetime a job entered into the job queue.

completed_at
string | null

The datetime the job completed.