Endpoint reference

Every endpoint of the QRCodeKIT API, with its method, its path and the fields it accepts. Generated from the API's own OpenAPI description, so it cannot drift from the running service.

AuthenticationEvery request needs an X-Api-Key header. Keys are issued instantly in the dashboard under Settings → API Keys. See Authentication for JWT and workspace headers.

Base URL: https://api.v2.qrcodekit.com

QR codes

Qr

Method	Path	What it does
GET	`/api/download-business-card/{uuid}`	Download Business Card.
GET	`/api/qr-download/{uuid}`	Download QR code in specified format.
GET	`/api/qrs`	Retrieves the collection of Qr resources.
POST	`/api/qrs`	Creates a Qr resource.
GET	`/api/qrs-compact`	Retrieves the collection of Qr resources.
POST	`/api/qrs/_bulk/delete`	Permanently deletes multiple Qr resources.
POST	`/api/qrs/_bulk/download`	Download multiple QR codes in bulk.
POST	`/api/qrs/_bulk/update`	Updates multiple Qr resources.
GET	`/api/qrs/{uuid}`	Retrieves a Qr resource.
PATCH	`/api/qrs/{uuid}`	Updates the Qr resource.
DELETE	`/api/qrs/{uuid}`	Removes the Qr resource.
GET	`/api/qrs/{uuid}/criteria`	Get Qr criteria array.
POST	`/api/qrs/bulk-create`	Creates multiple Qr resources from a file.
PATCH	`/api/qrs/clone/{uuid}`	Creates a clone of the resource.
GET	`/api/render/{pathName}`	Retrieves a Qr resource.

Request fields:

Field	Type	Required	Description
pathName	string		The pathname of the QR code - eg. https://qrkit.co/{pathName}
title	string		Optional. The title of the QR code
description	string		Optional. The description of the QR code
state	integer		The state of the QR code. Possible values: 0 (active), 1 (paused), 2 (archived).
domain	string (iri-reference)		The domain associated with the QR code.
project	string (iri-reference)		The project associated with the QR code.
typology	string (iri-reference)	yes	The typology of the QR code, defining its type.
input	string[]		The input data for the QR code, which varies based on the typology.
design	string (iri-reference)		Predefined design associated with the QR code, which can include custom styles and colors.
logo	string (iri-reference)		The logo associated with the QR code, which is displayed in the center of the QR code.
designParams	string[]		The design parameters for the QR code, which can include custom styles and colors.
invisibleParams	string[]		The invisible design parameters for the QR code.
landingTemplate	mixed		The landing template associated with the QR code. Required for certain QR types, such as landing pages.
cleoAssistantUuid	string		UUID of the Cleo AI assistant associated with this QR
hasReviews	boolean

Qr Typology

Method	Path	What it does
GET	`/api/qr-typologies`	Retrieves the collection of QrTypology resources.
GET	`/api/qr-typologies/{uuid}`	Retrieves a QrTypology resource.

Qr Design

Method	Path	What it does
GET	`/api/qr-designs`	Retrieves the collection of QrDesign resources.
GET	`/api/qr-designs-compact`	Retrieves the collection of QrDesign resources.
GET	`/api/qr-designs/{uuid}`	Retrieves a QrDesign resource.

Qr Logo

Method	Path	What it does
GET	`/api/qr-logos`	Retrieves the collection of QrLogo resources.
POST	`/api/qr-logos`	Creates a QrLogo resource.
GET	`/api/qr-logos-compact`	Retrieves the collection of QrLogo resources.
GET	`/api/qr-logos/{uuid}`	Retrieves a QrLogo resource.
DELETE	`/api/qr-logos/{uuid}`	Removes the QrLogo resource.

Qr Style

Method	Path	What it does
GET	`/api/qr-styles`	Retrieves the collection of QrStyle resources.
POST	`/api/qr-styles`	Creates a QrStyle resource.
GET	`/api/qr-styles/_draft`	Retrieves the collection of QrStyle resources.
GET	`/api/qr-styles/{uuid}`	Retrieves a QrStyle resource.
DELETE	`/api/qr-styles/{uuid}`	Removes the QrStyle resource.

Request fields:

Field	Type	Required	Description
design	string (iri-reference)
logo	string (iri-reference)
designParams	string[]

Theme

Method	Path	What it does
GET	`/api/themes`	Retrieves the collection of Theme resources.

Landing Template

Method	Path	What it does
GET	`/api/landing-templates/{uuid}`	Retrieves a LandingTemplate resource.

Qr Review

Method	Path	What it does
GET	`/api/qr-reviews/{uuid}`	Retrieves a QrReview resource.
PATCH	`/api/qr-reviews/{uuid}`	Updates the QrReview resource.
GET	`/api/qrs/{uuid}/reviews`	Retrieves the collection of QrReview resources.
GET	`/api/qrs/{uuid}/reviews/summary`	Retrieves a QrReview resource.
POST	`/api/qrs/review/submit`	Creates a QrReview resource.

Request fields:

Field	Type	Required
qrUuid	string	yes
componentId	string	yes
kind	string	yes
rating	integer	yes
locale	string
attribution	string[]
answers	string[]
reviewText	string
aiGenerated	boolean
publishedTo	string
categories	string[]
message	string
contactEmail	string (email)

Qr Form Response

Method	Path	What it does
GET	`/api/qrs/{uuid}/form-responses`	Retrieves the collection of QrFormResponse resources.
POST	`/api/qrs/form/submit`	Creates a QrFormResponse resource.

Request fields:

Field	Type	Required
qrUuid	string	yes
componentId	string	yes
fields	string[]	yes

Qr Form Version

Method	Path	What it does
GET	`/api/qrs/{uuid}/form-versions`	Retrieves the collection of QrFormVersion resources.

Organising your codes

Project

Method	Path	What it does
GET	`/api/projects`	Retrieves the collection of Project resources.
POST	`/api/projects`	Creates a Project resource.
GET	`/api/projects/{uuid}`	Retrieves a Project resource.
PATCH	`/api/projects/{uuid}`	Updates the Project resource.
DELETE	`/api/projects/{uuid}`	Removes the Project resource.

Request fields:

Field	Type	Required	Description
title	string	yes	Human-friendly project title

Tag

Method	Path	What it does
GET	`/api/qrs/{uuid}/tags`	Retrieves the collection of Tag resources.
GET	`/api/tags`	Retrieves the collection of Tag resources.
POST	`/api/tags-to-qr`	Creates a Tag resource.
GET	`/api/tags/{uuid}`	Retrieves a Tag resource.
DELETE	`/api/tags/{uuid}`	Removes the Tag resource.

Request fields:

Field	Type	Required	Description
name	string
qr	string (iri-reference)

Domain

Method	Path	What it does
POST	`/api/argocd/custom_domains/api/v1/getparams.execute`	Creates a Domain resource.
GET	`/api/domains`	Retrieves the collection of Domain resources.
POST	`/api/domains`	Creates a Domain resource.
PATCH	`/api/domains/{uuid}`	Updates the Domain resource.

Request fields:

Field	Type	Required	Description
name	string	yes

Trash List

Method	Path	What it does
GET	`/api/trash-lists`	Retrieves the collection of TrashList resources.

Asset

Method	Path	What it does
GET	`/api/assets/{uuid}`	Retrieves a Asset resource.
DELETE	`/api/assets/{uuid}`	Removes the Asset resource.
POST	`/api/assets/upload`	Creates a Asset resource.

Integrations

Webhook

Method	Path	What it does
GET	`/api/qrs/{qrUuid}/webhooks`	Retrieves the collection of Webhook resources.
POST	`/api/qrs/{qrUuid}/webhooks`	Creates a Webhook resource.
POST	`/api/webhooks`	Creates a Webhook resource.
GET	`/api/webhooks/{uuid}`	Retrieves a Webhook resource.
PATCH	`/api/webhooks/{uuid}`	Updates the Webhook resource.
DELETE	`/api/webhooks/{uuid}`	Removes the Webhook resource.

Request fields:

Field	Type	Required
url	string (uri)	yes
events	string[]	yes
qr_uuid	string

Job

Method	Path	What it does
GET	`/api/jobs/{uuid}`	Retrieves a Job resource.

Account and access

Api Key

Method	Path	What it does
GET	`/api/api-keys`	Retrieves the collection of ApiKey resources.
POST	`/api/api-keys`	Creates a ApiKey resource.
GET	`/api/api-keys/{uuid}`	Retrieves a ApiKey resource.
DELETE	`/api/api-keys/{uuid}`	Removes the ApiKey resource.

Request fields:

Field	Type	Required	Description
name	string

Method	Path	What it does
POST	`/api/login`	Creates a user token.

User

Method	Path	What it does
POST	`/api/hubspot/identification-token`	Creates a User resource.
POST	`/api/internal/user-token`	Creates a User resource.
GET	`/api/users`	Retrieves the collection of User resources.
GET	`/api/users/{uuid}`	Retrieves a User resource.
PATCH	`/api/users/{uuid}`	Updates the User resource.
DELETE	`/api/users/{uuid}`	Removes the User resource.
PATCH	`/api/users/admin-update/{uuid}`	Updates the User resource.
PATCH	`/api/users/email-update/{uuid}`	Updates the User resource.
PATCH	`/api/users/password-create/{uuid}`	Updates the User resource.
PATCH	`/api/users/password-reset/{uuid}`	Updates the User resource.
PATCH	`/api/users/password-update/{uuid}`	Updates the User resource.
POST	`/api/users/signup`	Creates a User resource.
POST	`/api/users/social-signup`	Creates a User resource.
POST	`/api/users/verify-email`	Creates a User resource.

Request fields:

Field	Type	Required	Description
email	string

User Account

Method	Path	What it does
GET	`/api/account-users`	Retrieves the collection of UserAccount resources.
POST	`/api/account-users`	Creates a UserAccount resource.
GET	`/api/account-users/{uuid}`	Retrieves a UserAccount resource.
PATCH	`/api/account-users/{uuid}`	Updates the UserAccount resource.
GET	`/api/user-accounts`	Retrieves the collection of UserAccount resources.
POST	`/api/user-accounts`	Creates a UserAccount resource.
GET	`/api/user-accounts/{uuid}`	Retrieves a UserAccount resource.
PATCH	`/api/user-accounts/{uuid}`	Updates the UserAccount resource.

Request fields:

Field	Type	Required
allowedProjects	string (iri-reference)[]
status	string
invitation	mixed
group	string (iri-reference)	yes

Account

Method	Path	What it does
GET	`/api/accounts`	Retrieves the collection of Account resources.
GET	`/api/accounts/{uuid}`	Retrieves a Account resource.
PATCH	`/api/accounts/{uuid}`	Updates the Account resource.
DELETE	`/api/accounts/{uuid}`	Removes the Account resource.
PATCH	`/api/accounts/downgrade/{uuid}`	Updates the Account resource.
PATCH	`/api/accounts/reactivate/{uuid}`	Updates the Account resource.
PATCH	`/api/accounts/restart-subscription/{uuid}`	Updates the Account resource.
PATCH	`/api/accounts/trial-begin/{uuid}`	Updates the Account resource.
PATCH	`/api/accounts/unsubscribe/{uuid}`	Updates the Account resource.
GET	`/api/public/account/{uuid}`	Retrieves a Account resource.

Account Detail

Method	Path	What it does
GET	`/api/account-details/{uuid}`	Retrieves a AccountDetail resource.
PATCH	`/api/account-details/{uuid}`	Updates the AccountDetail resource.

Group

Method	Path	What it does
GET	`/api/groups`	Retrieves the collection of Group resources.
GET	`/api/groups/{uuid}`	Retrieves a Group resource.

Plans and billing

Plan

Method	Path	What it does
GET	`/api/plans`	Retrieves the collection of Plan resources.
POST	`/api/plans`	Creates a Plan resource.
GET	`/api/plans-full`	Retrieves the collection of Plan resources, including related PlanPrice resources.
GET	`/api/plans/{uuid}`	Retrieves a Plan resource.
GET	`/api/plans/downgrade-info/{uuid}/{accountUuid}`	Retrieves a Plan resource.
GET	`/api/public/plans`	Public endpoint: Retrieves the collection of Plan resources, including related PlanPrice resources.

Request fields:

Field	Type	Required
name	string	yes
displayName	string	yes
displayDescription	string
isPremium	boolean
isActive	boolean
visible	boolean
hasTrial	boolean
parent	mixed
level	integer
features	string[]
publicDisplay	boolean
prices	—

Plan Price

Method	Path	What it does
GET	`/api/plan-prices`	Retrieves the collection of PlanPrice resources.
POST	`/api/plan-prices`	Creates a PlanPrice resource.
GET	`/api/plan-prices/{uuid}`	Retrieves a PlanPrice resource.
PATCH	`/api/plan-prices/{uuid}`	Updates the PlanPrice resource.
DELETE	`/api/plan-prices/{uuid}`	Removes the PlanPrice resource.

Request fields:

Field	Type	Required
name	string	yes
displayName	string	yes
months	integer	yes
plan	string (iri-reference)	yes
currency	integer
isActive	boolean
discount	string (iri-reference)
features	string[]

Invoice

Method	Path	What it does
GET	`/api/invoices`	Retrieves the collection of Invoice resources.
GET	`/api/invoices/{uuid}`	Retrieves a Invoice resource.

Order

Method	Path	What it does
POST	`/api/orders`	Creates a Order resource.
GET	`/api/orders-schedule`	Retrieves the collection of Order resources.
POST	`/api/orders-schedule`	Creates a Order resource.
DELETE	`/api/orders-schedule/{uuid}`	Removes the Order resource.
GET	`/api/orders/{uuid}`	Retrieves a Order resource.
GET	`/api/orders/check-status/{uuid}`	Retrieves a Order resource.
POST	`/api/public/orders`	Creates a Order resource.

Request fields:

Field	Type	Required
planPrice	string (iri-reference)
account	string (iri-reference)	yes
currency	integer
discount	string (iri-reference)
invoice	string (iri-reference)

Order Payment

Method	Path	What it does
GET	`/api/order-payments`	Retrieves the collection of OrderPayment resources.
GET	`/api/order-payments/{uuid}`	Retrieves a OrderPayment resource.

Payment Source

Method	Path	What it does
GET	`/api/payment-sources`	Retrieves the collection of PaymentSource resources.
GET	`/api/payment-sources/{uuid}`	Retrieves a PaymentSource resource.
GET	`/api/payment-sources/intent/{uuid}`	Retrieves a PaymentSource resource.

Payment Transaction

Method	Path	What it does
GET	`/api/payment-transactions`	Retrieves the collection of PaymentTransaction resources.
GET	`/api/payment-transactions/{uuid}`	Retrieves a PaymentTransaction resource.
POST	`/api/payment/checkout`	Create payment checkout session

Merchant Payment Account

Method	Path	What it does
GET	`/api/merchant-payment-accounts`	Retrieves the collection of MerchantPaymentAccount resources.
GET	`/api/merchant-payment-accounts/{uuid}`	Retrieves a MerchantPaymentAccount resource.
PATCH	`/api/merchant-payment-accounts/{uuid}`	Updates the MerchantPaymentAccount resource.
DELETE	`/api/merchant-payment-accounts/{uuid}`	Removes the MerchantPaymentAccount resource.
POST	`/api/merchant-payment-accounts/connect/{provider}`	Initiate payment provider OAuth flow
GET	`/api/merchant-payment-accounts/connect/{provider}/callback`	Handle payment provider OAuth callback

Billing Info

Method	Path	What it does
POST	`/api/billing-infos`	Creates a BillingInfo resource.
GET	`/api/billing-infos/{uuid}`	Retrieves a BillingInfo resource.
PATCH	`/api/billing-infos/{uuid}`	Updates the BillingInfo resource.

Request fields:

Field	Type	Required	Description
name	string
lastName	string
legalId	string
city	string
state	string
country	string
postalCode	string
email	string
phone	string
addressLine1	string
addressLine2	string

Discount

Method	Path	What it does
GET	`/api/public/discounts/{code}`	Retrieves a Discount resource.

Endpoint reference

QR codes

Qr

Qr Typology

Qr Design

Qr Logo

Qr Style

Theme

Landing Template

Qr Review

Qr Form Response

Qr Form Version

Organising your codes

Project

Tag

Domain

Trash List

Asset

Integrations

Webhook

Job

Account and access

Api Key

Login Check

User

User Account

Account

Account Detail

Group

Plans and billing

Plan

Plan Price

Invoice

Order

Order Payment

Payment Source

Payment Transaction

Merchant Payment Account

Billing Info

Discount