Skip to main content
GET
The QR category catalogue — the source of the category primary keys and slugs that every create, update, and filter call in this module needs.
On the Management API host this endpoint requires authentication. The same catalogue is open on the public API host, so code ported from there will start returning 401 here unless it sends the Authorization header.

Query parameters

string
Comma-separated filter on the QR types a category supports, e.g. st,dy,bt. Returns only categories that allow at least one of them.
string
Reshape the response into named sections instead of one All bucket. One of recommended, use_case, content_type, or favourite.
With ?view_type=recommended the same rows come back grouped under section names instead:
The response is a dict keyed by section name, not a bare array, and it is never paginated. Each row also carries description, preview_image, tags, helpdesk_link, qr_name_pattern, created, and modified.allowed_qr_types is what makes a create call succeed or fail: a static-only category rejects qr_type: "dy" and vice versa. qr_name_pattern is the template used to auto-name a QR Code created without a name.

Authorizations

Authorization
string
header
required

Send your Management API key as the raw value of the Authorization header — no "Bearer " or "Token " prefix, and no other characters. Example: Authorization: 401f7ac837da42b97f613d789819ff93537bee6a. A header containing more than one space-separated part is rejected outright. Requests also require the request's Host header to be the management API host (e.g. api.scanova.io) — the same key sent to the regular API host will not authenticate.

Query Parameters

allowed_qr_types
string

Comma-separated filter on supported QR types, e.g. st,dy,bt.

view_type
enum<string>

Reshape the response into named sections: recommended, use_case, content_type, or favourite.

Available options:
recommended,
use_case,
content_type,
favourite

Response

200 - application/json

Categories, keyed by section name.