Deductions
Documents
Management
Sandbox
- POSTCreate a new Sandbox Connection
- POSTCreate a new sandbox account
- PUTUpdate a sandbox account
- GETGet configurations for sandbox jobs
- PUTUpdate configurations for sandbox jobs
- POSTAdd a new sandbox payment
- PUTUpdate sandbox individual
- PUTUpdate sandbox employment
- POSTAdd new individuals to a sandbox company
- PUTUpdate a sandbox company's data
- POSTEnqueue a new sandbox job
Development Guides
List All Automated Jobs
Get all automated jobs. Automated jobs are completed by a machine. By default, jobs are sorted in descending order by submission time. For scheduled jobs such as data syncs, only the next scheduled job is shown.
import Finch from '@tryfinch/finch-api';
const client = new Finch({
accessToken: 'My Access Token',
});
async function main() {
const automateds = await client.jobs.automated.list();
console.log(automateds.data);
}
main();
{
"meta": {
"quotas": {
"data_sync_all": {
"allowed_refreshes": 123,
"remaining_refreshes": 123
}
}
},
"data": [
{
"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
Please use your Access Token
Headers
Header used to specify the version for a given API request. Current version is 2020-09-17.
Query Parameters
Number of items to return
Index to start from (defaults to 0)
Response
Information about remaining quotas for this connection. Only applicable for customers opted in to use Finch's Data Sync Refresh endpoint (POST /jobs/automated
). Please contact a Finch representative for more details.
The id of the job that has been created.
The url that can be used to retrieve the job status
The type of automated job
data_sync_all
, w4_form_employee_sync
pending
, in_progress
, complete
, error
, reauth_error
, permissions_error
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.
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.
The datetime a job entered into the job queue.
The datetime the job completed.
Was this page helpful?
import Finch from '@tryfinch/finch-api';
const client = new Finch({
accessToken: 'My Access Token',
});
async function main() {
const automateds = await client.jobs.automated.list();
console.log(automateds.data);
}
main();
{
"meta": {
"quotas": {
"data_sync_all": {
"allowed_refreshes": 123,
"remaining_refreshes": 123
}
}
},
"data": [
{
"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>"
}
}
]
}