List printers

Any signed in user. Returns a page of printers for a branch, default printer first. A branch_id may name another branch only for an admin; other callers stay on their own.

GET/api/v1/printing/printers

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.

pageinteger

One based page number. Defaults to 1.

page_sizeinteger

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

Responses

200

A page of printers

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

namestringrequired

kindstringrequired

connectionstringrequired

device_pathstringrequired

is_defaultintegerrequired

min -9007199254740991 · max 9007199254740991

copiesintegerrequired

min -9007199254740991 · max 9007199254740991

auto_printintegerrequired

min -9007199254740991 · max 9007199254740991

kick_drawerintegerrequired

min -9007199254740991 · max 9007199254740991

is_activeintegerrequired

min -9007199254740991 · max 9007199254740991

is_deletedintegerrequired

min -9007199254740991 · max 9007199254740991

created_atstringrequired

updated_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.pagequeryOne based page number. Defaults to 1.page_sizequeryRows per page, capped at 200. Defaults to 50.

Request

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

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

import requests

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

Response

{
  "total": -9007199254740991,
  "page": -9007199254740991,
  "page_size": -9007199254740991,
  "items": [
    {
      "id": "string",
      "branch_id": "string",
      "name": "string",
      "kind": "string",
      "connection": "string",
      "device_path": "string",
      "is_default": -9007199254740991,
      "copies": -9007199254740991,
      "auto_print": -9007199254740991,
      "kick_drawer": -9007199254740991,
      "is_active": -9007199254740991,
      "is_deleted": -9007199254740991,
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}

{
  "detail": "string"
}

{
  "detail": "string"
}