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

const client = new Finch({
  accessToken: 'My Access Token',
});

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

  console.log(automatedAsyncJob.job_id);
}

main();
{
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "job_url": "<string>",
  "type": "data_sync_all",
  "status": "pending",
  "created_at": "2023-11-07T05:31:56Z",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "params": {
    "individual_id": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Please use your Access Token

Headers

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

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

Path Parameters

job_id
string
required

Response

200
application/json
OK

The response is of type object.