Skip to content
Baobab QR

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 page

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"}}'
In the JSON body
FieldNeededWhat it is
typeYesWhat the code is: link, whatsapp, vcard (a contact card) or app (App download).
contentYesWhat the code holds, as for a new code of its type. For a link, where it goes.
content.urlYes, for link and applink and app: the web address it opens (https:// is added if you leave it off).
nameNoA name to find the code by, up to 80 characters. Left out, it is the link's domain or the contact's name.
folderNoA folder to put it in, up to 40 characters. On GET, only the codes in that folder.
trackingNoWhat scans record: full (country, city, device and time), count (the number only) or off. Usually full.
designFromNoThe short id of one of your codes, whose design (colours, dots, corners, label and logo) the new code takes.
content.phoneYes, for whatsappwhatsapp: the phone number with its country code, for example +27 82 123 4567.
content.messageNowhatsapp: a message typed in for the person, up to 500 characters.
content.nameYes, for vcardvcard: the person's or business's name, up to 100 characters.
content.organisationNovcard: the organisation, up to 100 characters.
content.jobTitleNovcard: the job title, up to 100 characters.
content.mobileNovcard: a mobile number, up to 30 characters.
content.workPhoneNovcard: a work number, up to 30 characters.
content.emailNovcard: an email address.
content.websiteNovcard: a website, up to 500 characters.
content.addressNovcard: a postal address, up to 300 characters.
content.noteNovcard: a note, up to 500 characters.
content.appStoreNoapp: the app's page on the App Store (https://apps.apple.com/…).
content.googlePlayNoapp: 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"
In the address
FieldNeededWhat it is
folderNoA folder to put it in, up to 40 characters. On GET, only the codes in that folder.
limitNoHow many codes a page has: 1 to 500, usually 100.
afterNoThe 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.svg

The 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"}}'
In the JSON body
FieldNeededWhat it is
versionNoThe code's version as you last read it. If it has changed since, the change is refused (409).
nameNoA name to find the code by, up to 80 characters. Left out, it is the link's domain or the contact's name.
contentNoWhat the code holds, as for a new code of its type. For a link, where it goes.
pausedNotrue 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.

StatusCodeWhen
400invalidA field doesn't fit; fields names each one, with what to change.
401invalid_keyNo key, or one we don't know.
401key_revokedThe key was revoked in Settings, or the person who made it left the team or became a viewer.
402plan_requiredThe workspace isn't on Business: the API comes with Business.
402code_limit_reachedThe workspace has 1,000 codes.
403code_blockedThe code was blocked for safety.
403code_lockedThe code can't change on the workspace's plan.
403code_under_reviewWe're reviewing the code, so it can't change for now.
404not_foundNo code with that short id in your workspace.
409version_conflictThe code changed since the version you sent.
422destination_rejectedThe link breaks our rules or Google Web Risk lists it.
429rate_limitedToo many requests in a minute.
429new_codes_limit1,000 new codes in the last 24 hours.
429too_fastA 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.