Skip to content

List bulk jobs

GET/documents/bulk

Costs 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

  • statusstring

    Only 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 of preparingpendingprocessingfinalizingcompletefailedcancelled
  • pageinteger

    1-based page number.

  • per_pageinteger

    Rows per page, default 25, max 100.

Returns

  • itemsarray of objects
    Show 14 child attributesHide child attributes
    • job_idinteger
      Example: 13
    • kindstring
      Example: print
    • statusstring
      Example: pending
    • progressinteger
      Example: 0
    • countinteger
      Example: 1
    • 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
  • pageobject

    Offset paging of a list (page, per_page query params).

    Show 4 child attributesHide child attributes
    • numberinteger

      1-based page number.

    • sizeinteger

      Rows per page, max 100.

    • totalinteger

      Rows across all pages.

    • total_pagesinteger
      Example: 1

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.

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
curl "https://app.invoicefalcon.com/api/v3/external/documents/bulk" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
Response
{
  "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
  }
}