POST
/
sandbox
/
jobs
import Finch from '@tryfinch/finch-api';

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

async function main() {
  const job = await client.sandbox.jobs.create({ type: 'data_sync_all' });

  console.log(job.job_id);
}

main();
{
  "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
  "job_url": "https://api.tryfinch.com/jobs/automated/453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
  "allowed_refreshes": 2,
  "remaining_refreshes": 1
}

Analagous to POST /jobs/automated, but for automated and assisted Finch Sandbox connections. Use this endpoint after updating a Finch Sandbox connection’s data to “sync” the data with Finch and see it reflected in /employer data API calls.

Assisted connections will return null for job_id and job_url, since no job is actually being created. Simply call this endpoint, and then call the /employer API to see the updated data.

Authorizations

​
Authorization
string
header
required

Please use your Access Token

Body

application/json
​
type
enum<string>
required

The type of job to start. Currently the only supported type is data_sync_all

Available options:
data_sync_all

Response

200 - application/json
OK
​
job_id
string
required

The id of the job that has been created.

​
job_url
string
required

The url that can be used to retrieve the job status

​
allowed_refreshes
integer
required

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

​
remaining_refreshes
integer
required

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

Was this page helpful?