List print jobs

Any signed in user. Returns a page of print jobs for a branch, newest first. A reference_id narrows it to one document’s jobs, which the receipt reprint history reads.

GET/api/v1/printing/print-jobs

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Query parameters

branch_idstring

The branch to read. Defaults to the caller's own branch.

reference_idstring

Limit to one document. Empty returns every job in the branch.

pageinteger

One based page number. Defaults to 1.

page_sizeinteger

Rows per page, capped at 200. Defaults to 20.

Responses

200

A page of print jobs

totalintegerrequired

min -9007199254740991 · max 9007199254740991

pageintegerrequired

min -9007199254740991 · max 9007199254740991

page_sizeintegerrequired

min -9007199254740991 · max 9007199254740991

itemsobject[]required

Show properties

Array of object

idstringrequired

branch_idstringrequired

printer_idstring | nullrequired

document_typestringrequired

reference_idstringrequired

copiesintegerrequired

min -9007199254740991 · max 9007199254740991

statusstringrequired

reasonstringrequired

created_bystringrequired

created_atstringrequired

401

Not authenticated

detailstringrequired

403

Branch is outside your ownership

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

branch_idqueryThe branch to read. Defaults to the caller's own branch.reference_idqueryLimit to one document. Empty returns every job in the branch.pagequeryOne based page number. Defaults to 1.page_sizequeryRows per page, capped at 200. Defaults to 20.

Request

curl -X GET 'http://localhost:8000/api/v1/printing/print-jobs' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("http://localhost:8000/api/v1/printing/print-jobs", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "http://localhost:8000/api/v1/printing/print-jobs",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "total": -9007199254740991,
  "page": -9007199254740991,
  "page_size": -9007199254740991,
  "items": [
    {
      "id": "string",
      "branch_id": "string",
      "printer_id": "string",
      "document_type": "string",
      "reference_id": "string",
      "copies": -9007199254740991,
      "status": "string",
      "reason": "string",
      "created_by": "string",
      "created_at": "string"
    }
  ]
}

{
  "detail": "string"
}

{
  "detail": "string"
}