QR Planet – QR Code API v2
This collection is the official QR Planet QR Code API v2 for building and managing QR experiences via API. Use it to create, update, and organize QR codes, download QR images (including Designer templates), manage folders/tags, and pull scan analytics. You can find the official documentation page via https://qrplanet.com/qr-code-api-docs Getting started Base URL: https://api.qrplanet.com Auth:…
QR Planet – QR Code API v2 endpoints
| Method | Endpoint | Description |
|---|---|---|
| QR Codes | ||
| GET |
download_image_designer_qr_code /api/v2/qrcodes/{code}/download-image/designer |
Download the image of a QR Code in the design of a Designer QR code template |
| POST |
add_qr_code_geofence /api/v2/qrcodes/{code}/geofences |
Add a geo-location-specific target URL to a QR code identified by its code. If the QR code gets scanned with that specific location then the user gets forwarded to this target… |
| PATCH |
change_qr_code_tags /api/v2/qrcodes/{code}/tags |
Change the tags of a QR Code identified by its code. |
| GET |
get_qr_code_stats /api/v2/qrcodes/{code}/stats |
Get the QR Code statistics identified by its code. |
| POST |
change_qr_code_type /api/v2/qrcodes/{code}/change-type |
Change the type and target url of the QR Code identified by its code. |
| DELETE |
delete_qr_code_georegion /api/v2/qrcodes/{code}/georegions/{georegion_id} |
Remove a georegion-specific target URL to a QR code identified by its code. |
| DELETE |
delete_qr_code_language /api/v2/qrcodes/{code}/languages/{language_code} |
Remove a language-specific target URL to a QR code identified by its code. |
| POST |
reset_qr_code_stats /api/v2/qrcodes/{code}/stats/reset |
Resets the QR Code statistics identified by its code. |
| GET |
get_qr_code /api/v2/qrcodes/{code} |
Returns a single QR code by its unique identifier. |
| DELETE |
delete_qr_code_tags /api/v2/qrcodes/{code}/tags |
Remove all the tags of a QR Code identified by its code. |
| POST |
add_qr_code_language /api/v2/qrcodes/{code}/languages |
Add a language-specific target URL to a QR code identified by its code. If the QR code gets scanned with a device in a certain language then the user gets forwarded to this… |
| DELETE |
delete_qr_code_geofence /api/v2/qrcodes/{code}/geofences/{geofence_id} |
Remove a geofence (lat, lng, radius)-specific target URL to a QR code identified by its code. |
| GET |
list_qr_codes /api/v2/qrcodes |
Returns a paginated list of **QR codes** in your account. **Use this endpoint to:** - List dynamic or static QR codes - Filter by type/subtype (URL, WIFI, TEXT, etc.) - Filter by… |
| DELETE |
delete_qr_code /api/v2/qrcodes/{code} |
Deletes a QR Code identified by its code. |
| PATCH |
change_qr_code /api/v2/qrcodes/{code} |
Change certain fields of a QR Code identified by its code. |
| POST |
add_qr_code_country /api/v2/qrcodes/{code}/countries |
Add a country specific target URL to a QR code identified by its code. If the QR code gets scanned in a specific country then the user gets forwarded to this target url. |
| DELETE |
delete_all_qr_codes /api/v2/qrcodes |
Deletes ALL QR Codes of this user. Be careful, this operation cannot be undone! |
| POST |
crate_qr_code /api/v2/qrcodes |
Creates a dynamic or static QR Code. Be aware that only for dynamic QR codes analytics are available and the target url can be changed later. You find some common examples below:… |
| GET |
get_qr_code_tags /api/v2/qrcodes/{code}/tags |
Get the tags that have been assigned to a QR code. |
| POST |
add_qr_code_georegion /api/v2/qrcodes/{code}/georegions |
Add a geo-region-specific target URL to a QR code identified by its code. If the QR code gets scanned with that specific location then the user gets forwarded to this target url.… |
| GET |
get_leads /api/v2/qrcodes/{code}/leads |
Get the ledas of a landingpage |
| DELETE |
delete_qr_code_country /api/v2/qrcodes/{code}/countries/{country_code} |
Remove a country specific target URL to a QR code identified by its code. |
| GET |
download_image_basic_qr_code /api/v2/qrcodes/{code}/download-image/basic |
Download the image of a QR Code in black/white without a Designer QR code template |
| Folders | ||
| POST |
create_folder /api/v2/folders |
Create a folder to house either your QR codes or Landing Pages. |
| POST |
reset_folder_stats /api/v2/folders/{folder_id}/stats/reset |
Resets the QR Code statistics of all QR codes in a folder. |
| DELETE |
delete_folder /api/v2/folders/{folder_id} |
Deletes a folder. |
| GET |
list_folders /api/v2/folders |
Returns a paginated list of your folders. |
| GET |
get_folder /api/v2/folders/{folder_id} |
Returns a single folder by its unique identifier. |
| GET |
get_folder_stats /api/v2/folders/{folder_id}/stats |
Get the folder statistics identified by its folder id. |
| Coupons | ||
| GET |
get_coupon_stats /api/v2/coupons/{code}/stats |
Returns the issue statistics of a Coupon. |
| POST |
issue_voucher /api/v2/coupons/{code}/issue-voucher |
Returns an issued voucher for a coupon. |
| GET |
get_coupon_redemptions /api/v2/coupons/{code}/redemptions |
Returns the redemption statistics of a Coupon. |
| GET |
list_coupons /api/v2/coupons |
Returns a paginated list of **Coupons** in your account. **Pagination:** uses `page` and `size`. |
| GS1 Digital Link | ||
| POST |
create_gs1 /api/v2/gs1-digital-link |
Creates a GS1 Digital Link QR Code. |
| GET |
list_rules /api/v2/gs1-digital-link/{code}/rules |
Returns a paginated list of Rules of a GS1 Digital Link. |
| DELETE |
gs1_delete_rules /api/v2/gs1-digital-link/{code}/rules |
Deletes all Rules of a GS1 Digital Link identified by its code. |
| POST |
create_gs1_rule /api/v2/gs1-digital-link/{code}/rules |
This API call adds a rule to a GS1 Digital Link QR Code based on LinkTypes/Languages. The following logic applies for Rules: - If a Rule matches then the user gets redirected to… |
| Designer Templates | ||
| GET |
list_designer_templates /api/v2/designer-templates |
Returns a paginated list of your Designer Templates to be used to generate Designer QR codes in /download-image/designer. |
| GET |
get_designer_template /api/v2/designer-templates/{designer_template_id} |
Returns a single designer template by its unique identifier. |
| Digital Business Cards | ||
| DELETE |
delete_bcard /api/v2/business-cards/{code} |
Delete a Digital Business Card identified by its code. |
| PATCH |
change_bcard /api/v2/business-cards/{code} |
Change certain fields of a Digital Business Card identified by its code. |
| POST |
create_bcard /api/v2/business-cards |
Creates a Digital Business Card. |
| GET |
get_bcard /api/v2/business-cards/{code} |
Returns a single Digital Business Card by its unique identifier. |
| GET |
list_bcards /api/v2/business-cards |
Returns a paginated list of **Digital Business Cards** in your account. **Pagination:** uses `page` and `size`. |
| POST |
upload_bcard_image /api/v2/business-cards/{code}/images/{kind} |
Uploads an image for an existing Digital Business Card. Can be a user image, logo image or background image (kind). Only JPEG, PNG, and GIF images are supported. cURL: ```bash… |
| Default | ||
| GET |
health_api_v2_health_get /api/v2/health |
Call this endpoint to check if the API is healthy |
QR Planet – QR Code API v2 pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|