Developers

Agency

API

Create codes, change where they point and read scan counts from your own systems. JSON over HTTPS. Keys come from Settings → API keys.

Authentication

Send your key as a bearer token. Keys can be revoked at any time.

curl https://qrcodeplanet.com/api/v1/codes \
  -H "Authorization: Bearer qcp_live_…"

Endpoints

POST /api/v1/codes Create a dynamic code. Send destination, and optionally name, slug and folder.
GET /api/v1/codes List codes. Filter by folder or status. Without paging you get the 1,000 most recently changed. To get every code, page through them: send ?limit= (up to 1,000), then send each answer’s next value back as ?after= until next is null.
GET /api/v1/codes/{id} Get one code.
PATCH /api/v1/codes/{id} Change destination, name, folder, end date (expires) or scan limit (scan_limit).
POST /api/v1/codes/{id}/pause Pause a code. Send {"paused": false} to resume.
GET /api/v1/codes/{id}/scans Scan counts by day, country and device. Add ?days=30 (up to 365).
DELETE /api/v1/codes/{id} Delete a code and its scan history.
GET /api/v1/analytics Scans, unique scans, time of day, places, devices and per-code numbers. Add ?from=YYYY-MM-DD&to=YYYY-MM-DD&tz=Asia/Karachi&codes=id,id.
POST /api/v1/conversions Report a conversion from your server. Send event (its id from the Analytics page) and token (the ?qcp= value) or code_id. Optional value, and id to make retries safe.
POST /api/v1/static Get a static code as SVG. Send text, and optionally color, background, size and ec.

Example: change a destination

curl -X PATCH https://qrcodeplanet.com/api/v1/codes/k7Q2xb \
  -H "Authorization: Bearer qcp_live_…" \
  -H "Content-Type: application/json" \
  -d '{"destination":"https://example.com/new-page"}'

{ "id": "k7Q2xb", "short_link": "https://qrcodeplanet.com/r/k7Q2xb",
  "destination": "https://example.com/new-page",
  "status": "active" }

New destinations go through the same safety check as the dashboard, so the status is checking for a few seconds before it becomes active.

Webhooks and limits

  • Add the address that should receive events in Settings → API keys. Each delivery is a JSON POST with an x-qcp-signature header: the HMAC-SHA256 of the body, signed with your webhook’s secret.
  • scan.created posts the code id, short link, country, city and device type. No IP addresses. Bots and link previews aren’t sent.
  • code.ended fires when a code reaches its scan limit.
  • lead.created posts a new lead from a form that has webhook delivery turned on.
  • 120 requests a minute per key, for every endpoint.