Quickstart

Make your first authenticated call to the BriefQR API in under five minutes. Everything here runs against test mode, an isolated namespace that never touches live data or billing.

1. Create a test key

In the BriefQR dashboard go to Developers → API keys → Create key, choose Test and Full, and copy the bqr_test_… key. It is shown once.

2. Make your first call

curl https://api.briefqr.com/v1/operators 
  -H "Authorization: Bearer bqr_test_..."

A fresh test namespace returns an empty list:

{ "object": "list", "data": [], "has_more": false, "next_cursor": null }

3. Create a test operator

curl -X POST https://api.briefqr.com/v1/operators 
  -H "Authorization: Bearer bqr_test_..." 
  -H "Content-Type: application/json" 
  -d '{ "ident": "NURSE01", "name": "Jane Doe" }'

{
  "object": "operator",
  "id": "…",
  "ident": "NURSE01",
  "name": "Jane Doe",
  "employee_id": null,
  "is_active": true,
  "livemode": false,
  "created_at": "…"
}

4. Subscribe a webhook

Register an endpoint and send yourself a test event, then verify its signature — see the webhooks guide.

5. Go live

When you are ready, mint a bqr_live_… key and change nothing else. The same code now reads and writes real data. See test vs live mode.

Next: authentication · pagination & errors · full API reference.