Skip to main content
GET
/
jobs
/
manual
/
{job_id}
JavaScript
import Finch from '@tryfinch/finch-api';

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

const manualAsyncJob = await client.jobs.manual.retrieve('job_id');

console.log(manualAsyncJob.job_id);
{
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "body": [
    "<any>"
  ]
}

Authorizations

Authorization
string
header
required

Please use your Access Token

Headers

Finch-API-Version
string<date>
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

Query Parameters

entity_id
string<uuid>

The entity ID to use when authenticating with a multi-account token. Required when using a multi-account token to specify which entity's data to access. Example: 123e4567-e89b-12d3-a456-426614174000

Response

OK

job_id
string<uuid>
required
status
enum<string>
required
Available options:
pending,
in_progress,
error,
complete
body
(any | null)[] | null
required

Specific information about the job, such as individual statuses for batch jobs.

I