Developers

API reference

Create and manage dynamic QR codes straight from your own code. Base URL: https://crowabout.co.uk

Authentication

Create a key under Settings → API Access, then send it as a bearer token. Keys are shown once — store them somewhere sensible.

Authorization: Bearer ca_live_xxxxxxxxxxxx

List QR codes

GET /api/v1/qr — returns your active codes.

curl https://crowabout.co.uk/api/v1/qr \
  -H "Authorization: Bearer ca_live_xxx"

{
  "data": [
    {
      "id": "…",
      "label": "Shop poster",
      "qr_type": "url",
      "destination_url": "https://example.com",
      "token": "…",
      "folder": "Campaigns",
      "scan_count": 42,
      "scan_url": "https://crowabout.co.uk/q/…",
      "created_at": "…"
    }
  ]
}

Create a QR code

POST /api/v1/qr — creates a dynamic (editable, trackable) code. Returns 201 with a scan_url to encode.

curl -X POST https://crowabout.co.uk/api/v1/qr \
  -H "Authorization: Bearer ca_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "destination_url": "https://example.com/offer",
    "label": "Summer flyer",
    "folder": "Campaigns"
  }'

Field	Required	Notes
`destination_url`	Yes	Where the code redirects (editable later)
`label`	No	Display name
`folder`	No	Group codes

Errors

Standard HTTP codes: 401 invalid/missing key, 400 bad request, 403 plan limit reached, 429 rate limit exceeded. Errors return { "error": "…" }.