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

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

async function main() {
  const automated = await client.jobs.automated.list();

  console.log(automated.data);
}

main();
{
  "": {
    "count": 10,
    "offset": 0
  },
  "meta": {
    "quotas": {
      "data_sync_all": {
        "allowed_refreshes": 2,
        "remaining_refreshes": 2
      }
    }
  },
  "data": [
    {
      "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": "complete",
      "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"
    }
  ]
}

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.

​
Content-Type
string
default:application/json
required

Used to indicate the original media type of the resource

Body

application/json
​
limit
integer

The number of items to return. Defaults to 100.

​
offset
integer

Where in the list of jobs to start returning from. Defaults to index 0.

Response

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

Was this page helpful?