Open Inventory / Docs

API: send your first request

The API runs at /api/v1 on your application instance. This public website hosts the reference.

Replace inventory.example.com with your instance address and set INVENTORY_API_TOKEN in your local shell. This request reads up to ten records without changing any data.

curl 'https://inventory.example.com/api/v1/resources?limit=10' \
  -H "Authorization: Bearer $INVENTORY_API_TOKEN"

API token

Inventory, stock and integrations. Create one under Settings → API and select the required scopes.

Browser session

Saved print lists, shared printers, print jobs and QZ signing. An ordinary API token cannot replace this sign-in.

Printer token (iprt_)

For the Windows agent only: claim and acknowledge jobs for its assigned printer.

User-bound credentials can select an active membership with X-Organization-ID. Standalone API tokens remain bound to their issuing organization. Endpoint permissions and, where applicable, item access apply in addition to scopes.

For endpoints using Idempotency-Key, assign a new UUID to each operation and reuse it only for the same request. For 409, inspect the conflict or running operation; for 422, check the input; for 429, check the rate limit. Print submissions use the UUID in the id field instead.

Interactive reference → · OpenAPI JSON → · OpenAPI YAML →

On this page