List bulk jobs
/documents/bulkCosts 1 rate-limit point · Rate limits
The shop bulk jobs, newest first, as the Bulk actions page lists them: kind, status, progress, count and the download link of finished PDF jobs.
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 aslist bulk jobsbulk action historymy bulk downloadsrecent bulk printsrunning bulk jobsbulk exports
Query parameters
statusstringOnly jobs in this status (pending, processing, complete, failed, cancelled). One of:
preparing(Preparing),pending(Queued),processing(Running),finalizing(Finishing),complete(Complete),failed(Failed),cancelled(Cancelled).One ofpreparingpendingprocessingfinalizingcompletefailedcancelledpageinteger1-based page number.
per_pageintegerRows per page, default 25, max 100.
Returns
itemsarray of objectsShow 14 child attributesHide child attributes
job_idintegerExample:13kindstringExample:printstatusstringExample:pendingprogressintegerExample:0countintegerExample:1failure_reasonstring, nullabledownload_urlstring, nullabledelivery_methodstringExample:printprocessing_typestring, nullabletemplate_namestringExample:defaultfromobject, nullabletostring, nullablecreated_atstringExample:2026-11-10T08:35:18Zupdated_atstringExample:2026-11-10T08:35:18Z
pageobjectOffset paging of a list (
page,per_pagequery params).Show 4 child attributesHide child attributes
numberinteger1-based page number.
sizeintegerRows per page, max 100.
totalintegerRows across all pages.
total_pagesintegerExample:1
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 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" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY"const res = await fetch("https://app.invoicefalcon.com/api/v3/external/documents/bulk", {
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",
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")
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)curl "https://app.invoicefalcon.com/api/v3/external/documents/bulk?status=preparing" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY"const res = await fetch("https://app.invoicefalcon.com/api/v3/external/documents/bulk?status=preparing", {
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?status=preparing",
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?status=preparing")
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){
"items": [
{
"job_id": 13,
"kind": "print",
"status": "pending",
"progress": 0,
"count": 1,
"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"
}
],
"page": {
"number": 1,
"size": 25,
"total": 1,
"total_pages": 1
}
}{
"errors": [
"Invalid API key"
],
"code": "unauthorized"
}{
"errors": [
"API access requires a paid plan"
],
"code": "paid_plan_required"
}{
"errors": [
"id is missing"
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited"
}