Retrieve a bulk job
/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_idintegerExample:13kindstringExample:printstatusstringExample:pendingprogressintegerExample:0countintegerExample:1completedarray of anysfailedarray of anysfailure_reasonstring, nullabledownload_urlstring, nullabledelivery_methodstringExample:printprocessing_typestring, nullabletemplate_namestringExample:defaultfromobject, nullabletostring, nullablecreated_atstringExample:2026-11-10T08:35:18Zupdated_atstringExample:2026-11-10T08:35:18Z
Errors
Missing or unknown X-Auth-Token, or the shop uninstalled the app.
v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.
The resource does not exist for this shop, or no action is registered at this path.
The request failed validation. Nothing was saved.
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.
curl "https://app.invoicefalcon.com/api/v3/external/documents/bulk/{job_id}" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY"const res = await fetch("https://app.invoicefalcon.com/api/v3/external/documents/bulk/{job_id}", {
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.invoicefalcon.com/api/v3/external/documents/bulk/{job_id}",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v3/external/documents/bulk/{job_id}")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"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"
}{
"errors": [
"Invalid API key"
],
"code": "unauthorized"
}{
"errors": [
"API access requires a paid plan"
],
"code": "paid_plan_required"
}{
"errors": [
"Resource not found"
],
"code": "not_found"
}{
"errors": [
"id is missing"
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited"
}