🚀 A major update to the RQrcode platform is currently being deployed to improve performance and add new features, which may temporarily cause minor slowdowns.
API documentation

QR codes

List, inspect, create, update, and delete your QR codes.

Authentication
Every request must send the Authorization header with a Bearer token matching the admin API key. Get API key.
API documentation

Endpoint
GET https://rqrcode.com/api/qr-codes/
Example
curl --request GET \
--url 'https://rqrcode.com/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}'
Parameters
Parameters Details Description
page
Optional ui.admin.api_docs.common.types.Integer
The page number that you want to get the results for. Defaults to 1.
results_per_page
Optional ui.admin.api_docs.common.types.Integer
How many results you want per page. Allowed values are: 10, 25, 50, 100, 250, 500, 1000. Defaults to 25.
Response example
{
    "data": [
        {
            "id": 1,
            "type": "url",
            "name": "Example name",
            "qr_code": "https://rqrcode.com/uploads/qr_code/example.svg",
            "qr_code_logo": null,
            "qr_code_background": null,
            "settings": {
                "foreground_type": "color",
                "foreground_color": "#000000",
                "background_color": "#ffffff",
                "custom_eyes_color": false,
                "qr_code_logo_size": 25,
                "size": 500,
                "margin": 0,
                "ecc": "L",
                "url": "https://example.com",
                "...": "..."
            },
            "embedded_data": "https://example.com",
            "last_datetime": null,
            "datetime": "2026-04-20 07:52:15"
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://rqrcode.com/api/qr-codes?page=1",
        "last": "https://rqrcode.com/api/qr-codes?page=1",
        "next": null,
        "prev": null,
        "self": "https://rqrcode.com/api/qr-codes?page=1"
    }
}

Endpoint
GET https://rqrcode.com/api/qr-codes/{qr_code_id}
Example
curl --request GET \
--url 'https://rqrcode.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}'
Parameters
No additional parameter.
Response example
{
    "data": {
        "id": 1,
        "type": "url",
        "name": "Example name",
        "qr_code": "https://rqrcode.com/uploads/qr_code/example.svg",
        "qr_code_logo": null,
        "qr_code_background": null,
        "settings": {
            "foreground_type": "color",
            "foreground_color": "#000000",
            "background_color": "#ffffff",
            "custom_eyes_color": false,
            "qr_code_logo_size": 25,
            "size": 500,
            "margin": 0,
            "ecc": "L",
            "url": "https://example.com",
            "...": "..."
        },
        "embedded_data": "https://example.com",
        "last_datetime": null,
        "datetime": "2026-04-20 07:52:15"
    }
}

Endpoint
POST https://rqrcode.com/api/qr-codes
Example
curl --request POST \
--url 'https://rqrcode.com/api/qr-codes' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=New York' \
--form 'type=text' \
--form 'text=Hello!'
Parameters
Parameters Details Description
link_id
Optional ui.admin.api_docs.common.types.Integer
-
project_id
Optional ui.admin.api_docs.common.types.Integer
-
name
Required ui.admin.api_docs.common.types.String
-
type
Required ui.admin.api_docs.common.types.String
Allowed values: text, url, pdf, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix
is_bulk
Optional ui.admin.api_docs.common.types.Boolean
Available when: type = text
style
Optional ui.admin.api_docs.common.types.String
Allowed values: square, dot, round, rounded, elastic_square, heart, diamond, star, triangle, hexagon, spaced_square, octagon, cross_x, curvy_x, rounded_cross, ninja, sun, shine, bold_plus, teardrop, corner_cut, randomized_square, bold_x
inner_eye_style
Optional ui.admin.api_docs.common.types.String
Allowed values: square, dot, rounded, diamond, flower, leaf
outer_eye_style
Optional ui.admin.api_docs.common.types.String
Allowed values: square, circle, rounded, flower, leaf
foreground_type
Optional ui.admin.api_docs.common.types.String
Allowed values: color, gradient
foreground_color
Optional ui.admin.api_docs.common.types.String
Available when: foreground_type = color
foreground_gradient_style
Optional ui.admin.api_docs.common.types.String
Allowed values: vertical, horizontal, diagonal, inverse_diagonal, radial
foreground_gradient_one
Optional ui.admin.api_docs.common.types.String
Available when: foreground_type = gradient
foreground_gradient_two
Optional ui.admin.api_docs.common.types.String
Available when: foreground_type = gradient
background_color
Optional ui.admin.api_docs.common.types.String
-
background_color_transparency
Optional ui.admin.api_docs.common.types.Integer
-
custom_eyes_color
Optional ui.admin.api_docs.common.types.Boolean
-
eyes_inner_color
Optional ui.admin.api_docs.common.types.String
Available when: custom_eyes_color = 1
eyes_outer_color
Optional ui.admin.api_docs.common.types.String
Available when: custom_eyes_color = 1
qr_code_logo
Optional ui.admin.api_docs.common.types.File
-
qr_code_logo_size
Optional ui.admin.api_docs.common.types.Integer
5-35
qr_code_background
Optional ui.admin.api_docs.common.types.File
-
qr_code_background_transparency
Optional ui.admin.api_docs.common.types.Integer
0-100
qr_code_foreground
Optional ui.admin.api_docs.common.types.File
-
qr_code_foreground_transparency
Optional ui.admin.api_docs.common.types.Integer
0-100
frame
Optional ui.admin.api_docs.common.types.String
Allowed values: circle_simple_bottom_text, round_simple_bottom_text, straight_simple_bottom_text, round_card_bottom_text, straight_bottom_text, straight_top_text, round_bottom_text, round_top_text, tooltip_bottom_text, tooltip_top_text, ribbon_bottom_text, ribbon_top_text, tooltip_snap_top_text, tooltip_snap_bottom_text, straight_semi_bordered_bottom_text, round_semi_bordered_bottom_text, hand_arrows_bottom_text, broken_ticket_bottom_text, smooth_ribbon_bottom_text
frame_text
Optional ui.admin.api_docs.common.types.String
-
frame_text_size
Optional ui.admin.api_docs.common.types.Integer
-5 - 5
frame_text_font
Optional ui.admin.api_docs.common.types.String
Allowed values: times_new_roman, georgia, courier, arial, helvetica, verdana, tahoma, trebuchet_ms, courier_new, monaco, comic_sans_ms, impact, luminari, baskerville, papyrus, brush_script_mt
frame_custom_colors
Optional ui.admin.api_docs.common.types.Boolean
-
frame_color
Optional ui.admin.api_docs.common.types.String
Available when: frame_custom_colors = 1
frame_text_color
Optional ui.admin.api_docs.common.types.String
Available when: frame_custom_colors = 1
size
Optional ui.admin.api_docs.common.types.Integer
50-2000
margin
Optional ui.admin.api_docs.common.types.Integer
0-25
ecc
Optional ui.admin.api_docs.common.types.String
Allowed values: L, M, Q, H
text
Optional ui.admin.api_docs.common.types.String
Available when: type = text
url
Optional ui.admin.api_docs.common.types.String
Available when: type = url
phone
Optional ui.admin.api_docs.common.types.String
Available when: type = phone
sms
Optional ui.admin.api_docs.common.types.String
Available when: type = sms
email
Optional ui.admin.api_docs.common.types.String
Available when: type = email
whatsapp
Optional ui.admin.api_docs.common.types.String
Available when: type = whatsapp
facetime
Optional ui.admin.api_docs.common.types.String
Available when: type = facetime
event
Optional ui.admin.api_docs.common.types.String
Available when: type = event
location
Optional ui.admin.api_docs.common.types.Object
-
wifi
Optional ui.admin.api_docs.common.types.Object
-
crypto
Optional ui.admin.api_docs.common.types.Object
-
vcard
Optional ui.admin.api_docs.common.types.Object
-
paypal
Optional ui.admin.api_docs.common.types.Object
-
upi
Optional ui.admin.api_docs.common.types.Object
-
epc
Optional ui.admin.api_docs.common.types.Object
-
pix
Optional ui.admin.api_docs.common.types.Object
-
Response example
{
    "data": {
        "id": 1
    }
}

Endpoint
POST https://rqrcode.com/api/qr-codes/{qr_code_id}
Example
curl --request POST \
--url 'https://rqrcode.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Las Vegas'
Parameters
Parameters Details Description
link_id
Optional ui.admin.api_docs.common.types.Integer
-
project_id
Optional ui.admin.api_docs.common.types.String
-
name
Optional ui.admin.api_docs.common.types.String
-
type
Optional ui.admin.api_docs.common.types.String
Allowed values: text, url, pdf, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix
style
Optional ui.admin.api_docs.common.types.String
Allowed values: square, dot, round, rounded, elastic_square, heart, diamond, star, triangle, hexagon, spaced_square, octagon, cross_x, curvy_x, rounded_cross, ninja, sun, shine, bold_plus, teardrop, corner_cut, randomized_square, bold_x
inner_eye_style
Optional ui.admin.api_docs.common.types.String
Allowed values: square, dot, rounded, diamond, flower, leaf
outer_eye_style
Optional ui.admin.api_docs.common.types.String
Allowed values: square, circle, rounded, flower, leaf
foreground_type
Optional ui.admin.api_docs.common.types.String
Allowed values: color, gradient
foreground_color
Optional ui.admin.api_docs.common.types.String
Available when: foreground_type = color
foreground_gradient_style
Optional ui.admin.api_docs.common.types.String
Allowed values: vertical, horizontal, diagonal, inverse_diagonal, radial
foreground_gradient_one
Optional ui.admin.api_docs.common.types.String
Available when: foreground_type = gradient
foreground_gradient_two
Optional ui.admin.api_docs.common.types.String
Available when: foreground_type = gradient
background_color
Optional ui.admin.api_docs.common.types.String
-
background_color_transparency
Optional ui.admin.api_docs.common.types.Integer
0 - 100
custom_eyes_color
Optional ui.admin.api_docs.common.types.Boolean
-
eyes_inner_color
Optional ui.admin.api_docs.common.types.String
Available when: custom_eyes_color = 1
eyes_outer_color
Optional ui.admin.api_docs.common.types.String
Available when: custom_eyes_color = 1
qr_code_logo
Optional ui.admin.api_docs.common.types.File
-
qr_code_logo_size
Optional ui.admin.api_docs.common.types.Integer
5-35
qr_code_background
Optional ui.admin.api_docs.common.types.File
-
qr_code_background_transparency
Optional ui.admin.api_docs.common.types.Integer
0-100
qr_code_foreground
Optional ui.admin.api_docs.common.types.File
-
qr_code_foreground_transparency
Optional ui.admin.api_docs.common.types.Integer
0-100
frame
Optional ui.admin.api_docs.common.types.String
Allowed values: circle_simple_bottom_text, round_simple_bottom_text, straight_simple_bottom_text, round_card_bottom_text, straight_bottom_text, straight_top_text, round_bottom_text, round_top_text, tooltip_bottom_text, tooltip_top_text, ribbon_bottom_text, ribbon_top_text, tooltip_snap_top_text, tooltip_snap_bottom_text, straight_semi_bordered_bottom_text, round_semi_bordered_bottom_text, hand_arrows_bottom_text, broken_ticket_bottom_text, smooth_ribbon_bottom_text
frame_text
Optional ui.admin.api_docs.common.types.String
-
frame_text_size
Optional ui.admin.api_docs.common.types.Integer
-5 -> 5
frame_text_font
Optional ui.admin.api_docs.common.types.String
Allowed values: times_new_roman, georgia, courier, arial, helvetica, verdana, tahoma, trebuchet_ms, courier_new, monaco, comic_sans_ms, impact, luminari, baskerville, papyrus, brush_script_mt
frame_custom_colors
Optional ui.admin.api_docs.common.types.Boolean
-
frame_color
Optional ui.admin.api_docs.common.types.String
Available when: frame_custom_colors = 1
frame_text_color
Optional ui.admin.api_docs.common.types.String
Available when: frame_custom_colors = 1
size
Optional ui.admin.api_docs.common.types.Integer
50-2000
margin
Optional ui.admin.api_docs.common.types.Integer
0-25
ecc
Optional ui.admin.api_docs.common.types.String
Allowed values: L, M, Q, H
text
Optional ui.admin.api_docs.common.types.String
Available when: type = text
url
Optional ui.admin.api_docs.common.types.String
Available when: type = url
phone
Optional ui.admin.api_docs.common.types.String
Available when: type = phone
sms
Optional ui.admin.api_docs.common.types.String
Available when: type = sms
email
Optional ui.admin.api_docs.common.types.String
Available when: type = email
whatsapp
Optional ui.admin.api_docs.common.types.String
Available when: type = whatsapp
facetime
Optional ui.admin.api_docs.common.types.String
Available when: type = facetime
event
Optional ui.admin.api_docs.common.types.String
Available when: type = event
location
Optional ui.admin.api_docs.common.types.Object
-
wifi
Optional ui.admin.api_docs.common.types.Object
-
crypto
Optional ui.admin.api_docs.common.types.Object
-
vcard
Optional ui.admin.api_docs.common.types.Object
-
paypal
Optional ui.admin.api_docs.common.types.Object
-
upi
Optional ui.admin.api_docs.common.types.Object
-
epc
Optional ui.admin.api_docs.common.types.Object
-
pix
Optional ui.admin.api_docs.common.types.Object
-
Response example
{
    "data": {
        "id": 1
    }
}

Endpoint
DELETE https://rqrcode.com/api/qr-codes/{qr_code_id}
Example
curl --request DELETE \
--url 'https://rqrcode.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}'
Parameters
No additional parameter.
Response example
Empty 200 response body on success.