Skip to content

API reference

The addresses your program can call with an API key, what each returns, and the format of webhook messages.

Where: Administration › Integrations › API › API referenceFor Owners, admins

Calling the API

Send the key in the Authorization header. Answers are JSON. At most 600 requests a minute per key.

Example: curl -H "Authorization: Bearer ssk_…" https://www.subclik.co.uk/api/v1/devices

Endpoints

GET /api/v1/devices: every printer with make, model, serial, IP, status, counters, toner and supplies, current alerts, customer, site and machine.

GET /api/v1/readings?from=2026-09-01&to=2026-09-30: daily meter readings per printer, at most 92 days per request.

GET /api/v1/events?since=2026-10-01T00:00:00Z: printer problems (jams, error codes, toner, waste box) with start and end, last 90 days.

GET /api/v1/readings.csv?month=2026-09: the month's readings as CSV, with start, end and copies per machine and meter (as in the monthly email).

Errors

"API key is not valid or was revoked": check the key or create a new one.

"too many requests, slow down": wait a minute.

"choose a period of at most 92 days (from, to)".

Webhook messages

JSON with event (printer.problem, job.created, job.completed, invoice.issued, invoice.paid or test), the details and a ready-made text. Check the X-SubClik-Signature: sha256=<hex> header (HMAC-SHA256 of the body with your signing secret).