Instale nosso aplicativo 🪄 Clique no ícone no canto superior direito da barra de endereço.

Códigos QR

Recuperar todos

GET https://link.joyproject.com.br/api/qr-codes/
curl --request GET \
--url 'https://link.joyproject.com.br/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}' \
Parâmetros Detalhes Descrição
search Opcional Cadeia A string de pesquisa.
search_by Opcional Cadeia Por qual campo você está pesquisando. Os valores permitidos são: name.
project_id Opcional Inteiro
type Opcional Cadeia Por qual campo você está pesquisando. Os valores permitidos são: text, url, phone, sms, email, whatsapp, facetime, facetime_audio, location, wifi, event, vcard, crypto, paypal, upi, epc, pix.
datetime_field Opcional Cadeia Valores permitidos: datetime, last_datetime
datetime_start Opcional Cadeia Filtre os resultados a partir desta data e hora. Formato Y-m-d H:i:s.
datetime_end Opcional Cadeia Filtre os resultados até esta data e hora. Formato Y-m-d H:i:s.
order_by Opcional Cadeia Por qual campo ordenar os resultados. Os valores permitidos são: qr_code_id, datetime, last_datetime, name, type.
order_type Opcional Cadeia A ordenação dos resultados. Os valores permitidos são: ASC para ordenação ascendente e DESC para ordenação descendente.
page Opcional Inteiro O número da página que deseja resultados. O padrão é 1.
results_per_page Opcional Inteiro Quantos resultados você deseja por página. Os valores permitidos são: 10, 25, 50, 100, 250, 500, 1000. O padrão é 25. 
{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "link_id": 1,
            "type": "Example",
            "name": "Example",
            "qr_code": "Example",
            "qr_code_logo": "Example",
            "qr_code_background": "Example",
            "qr_code_foreground": "Example",
            "settings": [],
            "embedded_data": "Example",
            "last_datetime": null,
            "datetime": "2026-09-20 12:40:28"
        }
    ],
    "meta": {
        "page": 1,
        "total_pages": 1,
        "results_per_page": 25,
        "total_results": 1
    },
    "links": {
        "first": "https://link.joyproject.com.br/api/qr-codes?page=1",
        "last": "https://link.joyproject.com.br/api/qr-codes?page=1",
        "next": null,
        "prev": null,
        "self": "https://link.joyproject.com.br/api/qr-codes?page=1"
    }
}

Recuperar um

GET https://link.joyproject.com.br/api/qr-codes/{qr_code_id}
curl --request GET \
--url 'https://link.joyproject.com.br/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "link_id": 1,
        "name": "Example",
        "type": "Example",
        "qr_code": "Example",
        "qr_code_logo": "Example",
        "qr_code_background": "Example",
        "qr_code_foreground": "Example",
        "settings": [],
        "embedded_data": "Example",
        "last_datetime": null,
        "datetime": "2026-09-20 12:40:28"
    }
}

Criar

POST https://link.joyproject.com.br/api/qr-codes
Parâmetros Detalhes Descrição
project_id Opcional Inteiro -
name Obrigatório Cadeia -
type Obrigatório Cadeia Valores permitidos: text, url, phone, sms, email, whatsapp, facetime, facetime_audio, location, wifi, event, vcard, crypto, paypal, upi, epc, pix
is_bulk Opcional Boolean Disponível quando: type = text
url_dynamic_existing_link Opcional Boolean Disponível quando: url_dynamic = 1
url_dynamic Opcional Boolean Disponível quando: type = url
link_id Opcional Inteiro Disponível quando: url_dynamic = 1 + url_dynamic_existing_link = 1
style Opcional Cadeia
inner_eye_style Opcional Cadeia Valores permitidos: square, dot, rounded, diamond, flower, leaf
outer_eye_style Opcional Cadeia Valores permitidos: square, circle, rounded, flower, leaf
foreground_type Opcional Cadeia Valores permitidos: color, gradient
foreground_color Opcional Cadeia Disponível quando: foreground_type = color
foreground_gradient_style Opcional Cadeia Valores permitidos: vertical, horizontal, diagonal, inverse_diagonal, radial
foreground_gradient_one Opcional Cadeia Disponível quando: foreground_type = gradient
foreground_gradient_two Opcional Cadeia Disponível quando: foreground_type = gradient
background_color Opcional Cadeia
background_color_transparency Opcional Inteiro
custom_eyes_color Opcional Boolean
eyes_inner_color Opcional Cadeia Disponível quando: custom_eyes_color = 1
eyes_outer_color Opcional Cadeia Disponível quando: custom_eyes_color = 1
qr_code_logo Opcional Arquivo -
qr_code_logo_size Opcional Inteiro 5-35
qr_code_background Opcional Arquivo -
qr_code_background_transparency Opcional Inteiro 0-100
qr_code_foreground Opcional Arquivo -
qr_code_foreground_transparency Opcional Inteiro 0-100
frame Opcional Cadeia Valores permitidos: 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 Opcional Cadeia
frame_text_size Opcional Inteiro -5 - 5
frame_text_font Opcional Cadeia Valores permitidos: 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 Opcional Boolean
frame_color Opcional Cadeia Disponível quando: frame_custom_colors = 1
frame_text_color Opcional Cadeia Disponível quando: frame_custom_colors = 1
size Opcional Inteiro 50-2000
margin Opcional Inteiro 0-25
ecc Opcional Cadeia Valores permitidos: L, M, Q, H
text Opcional Cadeia Disponível quando: type = text
url Opcional Cadeia Disponível quando: type = url. Disponível quando: url_dynamic = 0 / url_dynamic_existing_link = 0
phone Opcional Cadeia Disponível quando: type = phone
sms Opcional Cadeia Disponível quando: type = sms
sms_body Opcional Cadeia Disponível quando: type = sms
email Opcional Cadeia Disponível quando: type = email
whatsapp Opcional Cadeia Disponível quando: type = whatsapp
whatsapp_body Opcional Cadeia Disponível quando: type = whatsapp
facetime Opcional Cadeia Disponível quando: type = facetime
facetime_audio Opcional Cadeia Disponível quando: type = facetime_audio
location
location_latitude Opcional Flutuar Disponível quando: type = location
location_longitude Opcional Flutuar Disponível quando: type = location
wifi
wifi_ssid Opcional Cadeia Disponível quando: type = wifi
wifi_encryption Opcional Cadeia Valores permitidos: nopass, WEP, WPA/WPA2, H (type=wifi)
wifi_password Opcional Cadeia Disponível quando: type = wifi
wifi_is_hidden Opcional Boolean Disponível quando: type = wifi
event Opcional Cadeia Disponível quando: type = event
event_location Opcional Cadeia Disponível quando: type = event
event_url Opcional Cadeia Disponível quando: type = event
event_note Opcional Cadeia Disponível quando: type = event
event_timezone Opcional Cadeia Disponível quando: type = event
event_start_datetime Opcional Cadeia Disponível quando: type = event
event_end_datetime Opcional Cadeia Disponível quando: type = event
event_first_alert_datetime Opcional Cadeia Disponível quando: type = event
event_second_alert_datetime Opcional Cadeia Disponível quando: type = event
crypto
crypto_coin Opcional Cadeia Disponível quando: type = crypto
crypto_address Opcional Cadeia Disponível quando: type = crypto
crypto_amount Opcional Cadeia Disponível quando: type = crypto
vcard
vcard_first_name Opcional Cadeia Disponível quando: type = vcard
vcard_last_name Opcional Cadeia Disponível quando: type = vcard
vcard_company Opcional Cadeia Disponível quando: type = vcard
vcard_phone_number_label[index] Opcional Cadeia Disponível quando: type = vcard
vcard_phone_number_value[index] Opcional Cadeia Disponível quando: type = vcard
vcard_email Opcional Cadeia Disponível quando: type = vcard
vcard_url Opcional Cadeia Disponível quando: type = vcard
vcard_job_title Opcional Cadeia Disponível quando: type = vcard
vcard_birthday Opcional Cadeia Disponível quando: type = vcard
vcard_street Opcional Cadeia Disponível quando: type = vcard
vcard_city Opcional Cadeia Disponível quando: type = vcard
vcard_zip Opcional Cadeia Disponível quando: type = vcard
vcard_region Opcional Cadeia Disponível quando: type = vcard
vcard_country Opcional Cadeia Disponível quando: type = vcard
vcard_note Opcional Cadeia Disponível quando: type = vcard
vcard_social_label[index] Opcional Cadeia Disponível quando: type = vcard
vcard_social_value[index] Opcional Cadeia Disponível quando: type = vcard
paypal
paypal_type Opcional Cadeia Valores permitidos: buy_now, add_to_cart, donation (type=paypal)
paypal_email Opcional Cadeia Disponível quando: type = paypal
paypal_title Opcional Cadeia Disponível quando: type = paypal
paypal_currency Opcional Cadeia Disponível quando: type = paypal
paypal_price Opcional Flutuar Disponível quando: type = paypal
paypal_thank_you_url Opcional Cadeia Disponível quando: type = paypal
paypal_cancel_url Opcional Cadeia Disponível quando: type = paypal
upi
upi_payee_id Opcional Cadeia Disponível quando: type = upi
upi_payee_name Opcional Cadeia Disponível quando: type = upi
upi_currency Opcional Cadeia Disponível quando: type = upi
upi_amount Opcional Flutuar Disponível quando: type = upi
upi_transaction_id Opcional Cadeia Disponível quando: type = upi
upi_transaction_note Opcional Cadeia Disponível quando: type = upi
upi_transaction_reference Opcional Cadeia Disponível quando: type = upi
upi_thank_you_url Opcional Cadeia Disponível quando: type = upi
epc
epc_iban Opcional Cadeia Disponível quando: type = epc
epc_payee_name Opcional Cadeia Disponível quando: type = epc
epc_currency Opcional Cadeia Disponível quando: type = epc
epc_amount Opcional Flutuar Disponível quando: type = epc
epc_bic Opcional Cadeia Disponível quando: type = epc
epc_remittance_reference Opcional Cadeia Disponível quando: type = epc
epc_remittance_text Opcional Cadeia Disponível quando: type = epc
information Opcional Cadeia Disponível quando: type = epc
pix
pix_payee_key Opcional Cadeia Disponível quando: type = pix
pix_payee_name Opcional Cadeia Disponível quando: type = pix
pix_currency Opcional Cadeia Disponível quando: type = pix
pix_amount Opcional Flutuar Disponível quando: type = pix
pix_city Opcional Cadeia Disponível quando: type = pix
pix_transaction_id Opcional Cadeia Disponível quando: type = pix
pix_description Opcional Cadeia Disponível quando: type = pix
bulk_request Opcional Cadeia -
qr_code_logo_remove Opcional Boolean -
qr_code_background_remove Opcional Boolean -
qr_code_foreground_remove Opcional Boolean -
encoding Opcional Matriz -
sms Opcional Matriz -
email Opcional Matriz -
whatsapp Opcional Matriz -
event Opcional Matriz -
qr_code Opcional Matriz -
embedded_data Opcional Matriz -
Parâmetros Detalhes Descrição
curl --request POST \
--url 'https://link.joyproject.com.br/api/qr-codes' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=New York' \
--form 'type=text' \
--form 'text=Hello!' \
{
    "data": {
        "id": 1,
        "user_id": 1,
        "link_id": 1,
        "name": "Example",
        "type": "Example",
        "qr_code": "Example",
        "qr_code_logo": "Example",
        "qr_code_background": "Example",
        "qr_code_foreground": "Example",
        "settings": [],
        "embedded_data": "Example",
        "last_datetime": null,
        "datetime": "2026-09-20 12:40:28"
    }
}

Atualizar

POST https://link.joyproject.com.br/api/qr-codes/{qr_code_id}
Parâmetros Detalhes Descrição
project_id Opcional Cadeia -
name Opcional Cadeia -
type Opcional Cadeia Valores permitidos: text, url, phone, sms, email, whatsapp, facetime, facetime_audio, location, wifi, event, vcard, crypto, paypal, upi, epc, pix
url_dynamic Opcional Boolean Disponível quando: type = url
url_dynamic_existing_link Opcional Boolean Disponível quando: url_dynamic = 1
link_id Opcional Inteiro Disponível quando: url_dynamic = 1 + url_dynamic_existing_link = 1
style Opcional Cadeia Valores permitidos: 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 Opcional Cadeia Valores permitidos: square, dot, rounded, diamond, flower, leaf
outer_eye_style Opcional Cadeia Valores permitidos: square, circle, rounded, flower, leaf
foreground_type Opcional Cadeia Valores permitidos: color, gradient
foreground_color Opcional Cadeia Disponível quando: foreground_type = color
foreground_gradient_style Opcional Cadeia Valores permitidos: vertical, horizontal, diagonal, inverse_diagonal, radial
foreground_gradient_one Opcional Cadeia Disponível quando: foreground_type = gradient
foreground_gradient_two Opcional Cadeia Disponível quando: foreground_type = gradient
background_color Opcional Cadeia
background_color_transparency Opcional Inteiro 0 - 100
custom_eyes_color Opcional Boolean
eyes_inner_color Opcional Cadeia Disponível quando: custom_eyes_color = 1
eyes_outer_color Opcional Cadeia Disponível quando: custom_eyes_color = 1
qr_code_logo Opcional Arquivo -
qr_code_logo_size Opcional Inteiro 5-35
qr_code_background Opcional Arquivo -
qr_code_background_transparency Opcional Inteiro 0-100
qr_code_foreground Opcional Arquivo -
qr_code_foreground_transparency Opcional Inteiro 0-100
frame Opcional Cadeia Valores permitidos: 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 Opcional Cadeia
frame_text_size Opcional Inteiro -5 -> 5
frame_text_font Opcional Cadeia Valores permitidos: 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 Opcional Boolean
frame_color Opcional Cadeia Disponível quando: frame_custom_colors = 1
frame_text_color Opcional Cadeia Disponível quando: frame_custom_colors = 1
size Opcional Inteiro 50-2000
margin Opcional Inteiro 0-25
ecc Opcional Cadeia Valores permitidos: L, M, Q, H
text Opcional Cadeia Disponível quando: type = text
url Opcional Cadeia Disponível quando: type = url. Disponível quando: url_dynamic = 0 / url_dynamic_existing_link = 0
phone Opcional Cadeia Disponível quando: type = phone
sms Opcional Cadeia Disponível quando: type = sms
sms_body Opcional Cadeia Disponível quando: type = sms
email Opcional Cadeia Disponível quando: type = email
whatsapp Opcional Cadeia Disponível quando: type = whatsapp
whatsapp_body Opcional Cadeia Disponível quando: type = whatsapp
facetime Opcional Cadeia Disponível quando: type = facetime
facetime_audio Opcional Cadeia Disponível quando: type = facetime_audio
location
location_latitude Opcional Flutuar Disponível quando: type = location
location_longitude Opcional Flutuar Disponível quando: type = location
wifi
wifi_ssid Opcional Cadeia Disponível quando: type = wifi
wifi_encryption Opcional Cadeia Valores permitidos: nopass, WEP, WPA/WPA2, H (type=wifi)
wifi_password Opcional Cadeia Disponível quando: type = wifi
wifi_is_hidden Opcional Boolean Disponível quando: type = wifi
event Opcional Cadeia Disponível quando: type = event
event_location Opcional Cadeia Disponível quando: type = event
event_url Opcional Cadeia Disponível quando: type = event
event_note Opcional Cadeia Disponível quando: type = event
event_timezone Opcional Cadeia Disponível quando: type = event
event_start_datetime Opcional Cadeia Disponível quando: type = event
event_end_datetime Opcional Cadeia Disponível quando: type = event
event_first_alert_datetime Opcional Cadeia Disponível quando: type = event
event_second_alert_datetime Opcional Cadeia Disponível quando: type = event
crypto
crypto_coin Opcional Cadeia Disponível quando: type = crypto
crypto_address Opcional Cadeia Disponível quando: type = crypto
crypto_amount Opcional Cadeia Disponível quando: type = crypto
vcard
vcard_first_name Opcional Cadeia Disponível quando: type = vcard
vcard_last_name Opcional Cadeia Disponível quando: type = vcard
vcard_company Opcional Cadeia Disponível quando: type = vcard
vcard_phone_number_label[index] Opcional Cadeia Disponível quando: type = vcard
vcard_phone_number_value[index] Opcional Cadeia Disponível quando: type = vcard
vcard_email Opcional Cadeia Disponível quando: type = vcard
vcard_url Opcional Cadeia Disponível quando: type = vcard
vcard_job_title Opcional Cadeia Disponível quando: type = vcard
vcard_birthday Opcional Cadeia Disponível quando: type = vcard
vcard_street Opcional Cadeia Disponível quando: type = vcard
vcard_city Opcional Cadeia Disponível quando: type = vcard
vcard_zip Opcional Cadeia Disponível quando: type = vcard
vcard_region Opcional Cadeia Disponível quando: type = vcard
vcard_country Opcional Cadeia Disponível quando: type = vcard
vcard_note Opcional Cadeia Disponível quando: type = vcard
vcard_social_label[index] Opcional Cadeia Disponível quando: type = vcard
vcard_social_value[index] Opcional Cadeia Disponível quando: type = vcard
paypal
paypal_type Opcional Cadeia Valores permitidos: buy_now, add_to_cart, donation (type=paypal)
paypal_email Opcional Cadeia Disponível quando: type = paypal
paypal_title Opcional Cadeia Disponível quando: type = paypal
paypal_currency Opcional Cadeia Disponível quando: type = paypal
paypal_price Opcional Flutuar Disponível quando: type = paypal
paypal_thank_you_url Opcional Cadeia Disponível quando: type = paypal
paypal_cancel_url Opcional Cadeia Disponível quando: type = paypal
upi
upi_payee_id Opcional Cadeia Disponível quando: type = upi
upi_payee_name Opcional Cadeia Disponível quando: type = upi
upi_currency Opcional Cadeia Disponível quando: type = upi
upi_amount Opcional Flutuar Disponível quando: type = upi
upi_transaction_id Opcional Cadeia Disponível quando: type = upi
upi_transaction_note Opcional Cadeia Disponível quando: type = upi
upi_transaction_reference Opcional Cadeia Disponível quando: type = upi
upi_thank_you_url Opcional Cadeia Disponível quando: type = upi
epc
epc_iban Opcional Cadeia Disponível quando: type = epc
epc_payee_name Opcional Cadeia Disponível quando: type = epc
epc_currency Opcional Cadeia Disponível quando: type = epc
epc_amount Opcional Flutuar Disponível quando: type = epc
epc_bic Opcional Cadeia Disponível quando: type = epc
epc_remittance_reference Opcional Cadeia Disponível quando: type = epc
epc_remittance_text Opcional Cadeia Disponível quando: type = epc
information Opcional Cadeia Disponível quando: type = epc
pix
pix_payee_key Opcional Cadeia Disponível quando: type = pix
pix_payee_name Opcional Cadeia Disponível quando: type = pix
pix_currency Opcional Cadeia Disponível quando: type = pix
pix_amount Opcional Flutuar Disponível quando: type = pix
pix_city Opcional Cadeia Disponível quando: type = pix
pix_transaction_id Opcional Cadeia Disponível quando: type = pix
pix_description Opcional Cadeia Disponível quando: type = pix
qr_code_logo_remove Opcional Boolean -
qr_code_background_remove Opcional Boolean -
qr_code_foreground_remove Opcional Boolean -
encoding Opcional Matriz -
sms Opcional Matriz -
email Opcional Matriz -
whatsapp Opcional Matriz -
event Opcional Matriz -
qr_code Opcional Matriz -
embedded_data Opcional Matriz -
curl --request POST \
--url 'https://link.joyproject.com.br/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Las Vegas' \
{
    "data": {
        "id": 1,
        "user_id": 1,
        "link_id": 1,
        "name": "Example",
        "type": "Example",
        "qr_code": "Example",
        "qr_code_logo": "Example",
        "qr_code_background": "Example",
        "qr_code_foreground": "Example",
        "settings": [],
        "embedded_data": "Example",
        "last_datetime": null,
        "datetime": "2026-09-20 12:40:28"
    }
}

Apagar

DELETE https://link.joyproject.com.br/api/qr-codes/{qr_code_id}
curl --request DELETE \
--url 'https://link.joyproject.com.br/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \