Skip to content

Retrieve a bulk job

GET/documents/bulk/{job_id}

Costs 1 rate-limit point · Rate limits

One bulk job: status (pending, processing, finalizing, complete, failed, cancelled), progress, the invoices done and failed by number, the failure reason, and for a finished PDF job a signed download link valid for one week.

status values: preparing (Preparing), pending (Queued), processing (Running), finalizing (Finishing), complete (Complete), failed (Failed), cancelled (Cancelled).

kind values: print (PDF print / download), send (Email send), csv (CSV export).

Also searched asbulk job statusis my bulk download readybulk print progressdownload bulk pdfcheck bulk sendbulk action result

Path parameters

  • job_idstringRequired

Returns

  • job_idinteger
    Example: 13
  • kindstring
    Example: print
  • statusstring
    Example: pending
  • progressinteger
    Example: 0
  • countinteger
    Example: 1
  • completedarray of anys
  • failedarray of anys
  • failure_reasonstring, nullable
  • download_urlstring, nullable
  • delivery_methodstring
    Example: print
  • processing_typestring, nullable
  • template_namestring
    Example: default
  • fromobject, nullable
  • tostring, nullable
  • created_atstring
    Example: 2026-11-10T08:35:18Z
  • updated_atstring
    Example: 2026-11-10T08:35:18Z

Errors

401

Missing or unknown X-Auth-Token, or the shop uninstalled the app.

403

v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.

404

The resource does not exist for this shop, or no action is registered at this path.

422

The request failed validation. Nothing was saved.

429

Rate limited: cost-weighted per key (reads cost less than writes). Wait Retry-After seconds; see X-RateLimit-* headers.

Every error has the same shape: see Errors.

GET/documents/bulk/{job_id}
curl "https://app.invoicefalcon.com/api/v3/external/documents/bulk/{job_id}" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
Response
{
  "job_id": 13,
  "kind": "print",
  "status": "pending",
  "progress": 0,
  "count": 1,
  "completed": [],
  "failed": [],
  "failure_reason": null,
  "download_url": null,
  "delivery_method": "print",
  "processing_type": null,
  "template_name": "default",
  "from": null,
  "to": null,
  "created_at": "2026-11-10T08:35:18Z",
  "updated_at": "2026-11-10T08:35:18Z"
}