GET
/
jobs
/
automated
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>"
      }
    }
  ]
}

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.

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.

Query Parameters

​
limit
integer

Number of items to return

​
offset
integer

Index to start from (defaults to 0)

Response

200
application/json
Job was found
​
meta
object
required
​
data
object[]
required

Was this page helpful?