API reference

Jobs

get/v1/jobs/{job_id}

Get a job

jobs.getread tokenidempotent

A job started by a long operation (imports.create, plaid_items.sync, categorization.run, …), by the id its 202 answered with. Poll until status is succeeded or failed; a second or two between polls is plenty. Jobs are kept for 30 days.

Parameters

job_id integer · path · required
X-Organization-Id string \| null · header

Returns 200 · Job

created_at datetime · required
error JobError \| null · required	Why it failed, once `failed`.
finished_at datetime \| null · required
id integer · required
kind string · required	What the job does: `import`, `categorize`, `generate_journals`, `reconcile`, `run_schedules`, `plaid_sync` or `rocket_money_import`.
result object \| null · required	What the work produced, once `succeeded`. Its fields depend on `kind` and are listed on the operation that started it. Counts are integers.
status string · required	`queued`, `running`, `succeeded` or `failed`.

Example

curl -X GET "https://api.lumaledger.app/v1/jobs/{job_id}" \
  -H "Authorization: Bearer $LUMALEDGER_TOKEN"

Objects

Job

Work that outlives the request that started it. Poll jobs.get until status is succeeded or failed.

Fields

created_at datetime · required
error JobError \| null · required	Why it failed, once `failed`.
finished_at datetime \| null · required
id integer · required
kind string · required	What the job does: `import`, `categorize`, `generate_journals`, `reconcile`, `run_schedules`, `plaid_sync` or `rocket_money_import`.
result object \| null · required	What the work produced, once `succeeded`. Its fields depend on `kind` and are listed on the operation that started it. Counts are integers.
status string · required	`queued`, `running`, `succeeded` or `failed`.

JobError

Fields

code string · required	Stable error code, as in the error envelope.
message string · required	For people, in the request's language. Never match on it.