API Version 2.0

Authentication

The Master QR API uses API keys to authenticate requests. You can view and manage your API keys in the Developer Dashboard.

Authentication to the API is performed via HTTP Bearer Auth. Provide your API key as the basic auth username value. You do not need to provide a password.

Keep your keys safe

Your API keys carry many privileges. Do not share your secret API keys in publicly accessible areas such as GitHub or client-side code. If your key is compromised, roll it immediately in the dashboard.

Rate Limits

To prevent abuse and ensure platform stability, all API requests are subject to rate limiting. Limits are applied on a per-workspace basis.

Endpoint Category	Limit	Window
/v1/qr/*	100 requests	Per minute
/v1/analytics/*	50 requests	Per minute

If you exceed these limits, the API will respond with a 429 Too Many Requests status code.

Errors

QR Master uses conventional HTTP response codes to indicate the success or failure of an API request.

2xxSuccess! The request worked exactly as expected.
4xxClient Error. The request lacked valid authentication, or a parameter was invalid.
5xxServer Error. Something went wrong on our end (these are extremely rare).

Webhooks

Webhooks allow you to build or set up integrations which subscribe to certain events on QR Master. When one of those events is triggered, we'll send a HTTP POST payload to the webhook's configured URL.

Event Signatures

We sign all webhook events sent to your endpoints so you can verify they actually came from us. The signature is included in the X-QRMaster-Signature header.

Create QR Code

Creates a new dynamic QR code routing object. This endpoint provisions the edge network redirect and generates the high-fidelity vector image.

POSThttps://api.qrmaster.io/v1/qr/create

Body Parameters

destination_urlstringRequired

The primary destination URL that the dynamic QR code will redirect to upon scanning. Must be a valid HTTP/HTTPS URL.

typeenum

The core routing type for the QR code payload. Default is url.

urlvcardpdfapp_store

designobject

Advanced styling parameters to brand the generated QR code image via our canvas engine.

patternstring

The inner matrix pattern style. (e.g., squares, dots, fluid)

foreground_colorstring

Hex color code for the QR data pattern. Default: #000000

List Campaigns

Returns a paginated list of your QR code campaigns. The campaigns are returned sorted by creation date, with the most recent campaigns appearing first.

GEThttps://api.qrmaster.io/v1/qr

Query Parameters

limitinteger

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Analytics Pipeline

Retrieves time-series scan data for a specific QR code, including geographic distribution, device types, and browser footprints. Data is updated in real-time.

GEThttps://api.qrmaster.io/v1/analytics/:id

Path Parameters

idstringRequired

The unique identifier of the QR code campaign (e.g., qr_9x8y7z6w5v4u).