The Baobab QR API
Make and change Baobab QR codes from your own software: a till, a booking system, a label printer or a print shop's order form.
The API comes with Business. It makes and changes codes in your own workspace with the same rules and checks as the dashboard: every link is checked before its code goes live, and the same limits apply.
See Business on the pricing pageKeys
- The owner of a Business workspace makes keys in Settings, under API keys: give the key a name, then copy it. We show it only once, and keep only a scrambled copy.
- A key starts with
bqr_live_. Send it with every request, in the headerAuthorization: Bearer bqr_live_… - Keep keys on your own server. Never put one in a web page or an app people can download, where anyone could read it.
- Revoke a key in Settings and it stops working at once. A key also stops when the person who made it leaves the team, is removed from it or becomes a viewer, and while the workspace isn't on Business. A workspace can have up to 10 keys.
Requests
Send JSON to https://baobabqr.com/v1. A code is named by its short id, the 7 characters at the end of its address, such as 7K2XQ9P. The examples keep the key in $BAOBAB_QR_KEY.
Endpoints
POST /v1/codes
Make a code. Its link is checked as in the dashboard; a link that needs a closer look is held (status checking) until we've checked it.
curl https://baobabqr.com/v1/codes \
-H "Authorization: Bearer $BAOBAB_QR_KEY" \
-X POST -H "Content-Type: application/json" -d '{"type": "link", "name": "Table 4", "folder": "Tables", "content": {"url": "https://example.com/menu"}}'| Field | Needed | What it is |
|---|---|---|
| type | Yes | What the code is: link, whatsapp, vcard (a contact card) or app (App download). |
| content | Yes | What the code holds, as for a new code of its type. For a link, where it goes. |
| content.url | Yes, for link and app | link and app: the web address it opens (https:// is added if you leave it off). |
| name | No | A name to find the code by, up to 80 characters. Left out, it is the link's domain or the contact's name. |
| folder | No | A folder to put it in, up to 40 characters. On GET, only the codes in that folder. |
| tracking | No | What scans record: full (country, city, device and time), count (the number only) or off. Usually full. |
| designFrom | No | The short id of one of your codes, whose design (colours, dots, corners, label and logo) the new code takes. |
| content.phone | Yes, for whatsapp | whatsapp: the phone number with its country code, for example +27 82 123 4567. |
| content.message | No | whatsapp: a message typed in for the person, up to 500 characters. |
| content.name | Yes, for vcard | vcard: the person's or business's name, up to 100 characters. |
| content.organisation | No | vcard: the organisation, up to 100 characters. |
| content.jobTitle | No | vcard: the job title, up to 100 characters. |
| content.mobile | No | vcard: a mobile number, up to 30 characters. |
| content.workPhone | No | vcard: a work number, up to 30 characters. |
| content.email | No | vcard: an email address. |
| content.website | No | vcard: a website, up to 500 characters. |
| content.address | No | vcard: a postal address, up to 300 characters. |
| content.note | No | vcard: a note, up to 500 characters. |
| content.appStore | No | app: the app's page on the App Store (https://apps.apple.com/…). |
| content.googlePlay | No | app: the app's page on Google Play (https://play.google.com/store/apps/details?id=…). |
The answer: 201 {"code": {"id": "7K2XQ9P", "shortUrl": "https://baobabqr.app/7K2XQ9P", "type": "link", "name": "Table 4", "folder": "Tables", "content": {"url": "https://example.com/menu"}, "status": "live", "tracking": "full", "version": 1, "createdAt": "2026-11-04T09:30:00Z", "updatedAt": "2026-11-04T09:30:00Z"}}
GET /v1/codes
List your codes that aren't deleted, newest first.
curl https://baobabqr.com/v1/codes \
-H "Authorization: Bearer $BAOBAB_QR_KEY" \
-G --data-urlencode "folder=Tables" --data-urlencode "limit=100"| Field | Needed | What it is |
|---|---|---|
| folder | No | A folder to put it in, up to 40 characters. On GET, only the codes in that folder. |
| limit | No | How many codes a page has: 1 to 500, usually 100. |
| after | No | The short id the last page ended with (its next), for the page after it. |
The answer: 200 {"codes": [ … ], "next": "7K2XQ9P"}, each code as below; ask again with after set to next for the page after, until next is null
GET /v1/codes/{id}
Read one code, by its short id.
curl https://baobabqr.com/v1/codes/7K2XQ9P \
-H "Authorization: Bearer $BAOBAB_QR_KEY"The answer: 200 {"code": {"id": "7K2XQ9P", "shortUrl": "https://baobabqr.app/7K2XQ9P", "type": "link", "name": "Table 4", "folder": "Tables", "content": {"url": "https://example.com/menu"}, "status": "live", "tracking": "full", "version": 1, "createdAt": "2026-11-04T09:30:00Z", "updatedAt": "2026-11-04T09:30:00Z"}}
GET /v1/codes/{id}/svg
A code's picture as an SVG, in its own design and logo, as the dashboard's SVG download draws it.
curl https://baobabqr.com/v1/codes/7K2XQ9P/svg \
-H "Authorization: Bearer $BAOBAB_QR_KEY" \
-o code.svgThe answer: 200 the SVG (image/svg+xml)
PATCH /v1/codes/{id}
Change a code's name or where it goes, or pause or resume it.
curl https://baobabqr.com/v1/codes/7K2XQ9P \
-H "Authorization: Bearer $BAOBAB_QR_KEY" \
-X PATCH -H "Content-Type: application/json" -d '{"content": {"url": "https://example.com/menu-summer"}}'| Field | Needed | What it is |
|---|---|---|
| version | No | The code's version as you last read it. If it has changed since, the change is refused (409). |
| name | No | A name to find the code by, up to 80 characters. Left out, it is the link's domain or the contact's name. |
| content | No | What the code holds, as for a new code of its type. For a link, where it goes. |
| paused | No | true pauses the code, false resumes it. Send it on its own. |
The answer: 200 the code, as above, with its new version
What a code looks like
- id
- The short id, the 7 characters at the end of its address.
- shortUrl
- The address the QR code holds.
- type
- link, whatsapp, vcard, pdf or app.
- name
- Its name.
- folder
- Its folder, or null.
- content
- What it holds, as you sent it (a link's address with https://).
- status
- live; checking (we're checking its link, and it opens once the check passes, usually within minutes); reviewing (we're reviewing it); paused; or blocked.
- tracking
- full, count or off.
- version
- Goes up by one with each change.
- createdAt, updatedAt
- When it was made and last changed (UTC).
Errors
An error comes with its HTTP status and a JSON body: {"error": {"code": "invalid", "message": "…", "fields": {"content.url": "…"}}}. The code is for your software; the message is written for people, so you can show it as it is. A refused field is named in fields.
| Status | Code | When |
|---|---|---|
| 400 | invalid | A field doesn't fit; fields names each one, with what to change. |
| 401 | invalid_key | No key, or one we don't know. |
| 401 | key_revoked | The key was revoked in Settings, or the person who made it left the team or became a viewer. |
| 402 | plan_required | The workspace isn't on Business: the API comes with Business. |
| 402 | code_limit_reached | The workspace has 1,000 codes. |
| 403 | code_blocked | The code was blocked for safety. |
| 403 | code_locked | The code can't change on the workspace's plan. |
| 403 | code_under_review | We're reviewing the code, so it can't change for now. |
| 404 | not_found | No code with that short id in your workspace. |
| 409 | version_conflict | The code changed since the version you sent. |
| 422 | destination_rejected | The link breaks our rules or Google Web Risk lists it. |
| 429 | rate_limited | Too many requests in a minute. |
| 429 | new_codes_limit | 1,000 new codes in the last 24 hours. |
| 429 | too_fast | A second change to one code within a second. |
Limits
- 120 requests a minute for each key.
- At most 60 changes a minute for the workspace, made in the dashboard and with keys together.
- Up to 1,000 codes in a workspace, and 1,000 new codes in any 24 hours, deleted ones included.
- One change to a code a second.
- Up to 10 keys a workspace.
Questions? Email support@baobabqr.com.