API resources and fields

Every resource the QRCodeKIT API exposes, with its path and its fields. Generated from the API's own description, so it cannot drift from the running service.

What this page coversResources and their fields. For the operations — creating a code, bulk creation, analytics queries and authentication — see the guides, which carry worked requests for each.

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

/api/qrs

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	Domain (IRI)		The domain associated with the QR code.
project	Project (IRI)		The project associated with the QR code.
typology	QrTypology (IRI)	yes	The typology of the QR code, defining its type.
visitsTotal	integer
assetUrl	string		The URL of the QR code image asset.
input	—		The input data for the QR code, which varies based on the typology.
design	QrDesign (IRI)		Predefined design associated with the QR code, which can include custom styles and colors.
logo	QrLogo (IRI)		The logo associated with the QR code, which is displayed in the center of the QR code.
designParams	—		The design parameters for the QR code, which can include custom styles and colors.
invisibleParams	—		The invisible design parameters for the QR code.
stateReason	string		The reason for the current state of the QR code, providing context for its status.
landingTemplate	LandingTemplate (IRI)		The landing template associated with the QR code. Required for certain QR types, such as landing pages.
assets	—		The image URLs in multiple formats of the QR Code Image.
qrStyleHash	string		MD5 hash of QR style components (logo, design params, design) for cache invalidation
cleoAssistantUuid	string		UUID of the Cleo AI assistant associated with this QR
hasForm	boolean
hasReviews	boolean
updatedAt	date-time
url	string

Qr Typology

/api/qr-typologies

Field	Type	Required	Description
internalName	string
defaultDesign	QrDesign (IRI)
defaultLogo	QrLogo (IRI)
defaultTheme	Theme (IRI)
enabled	boolean

Qr Design

/api/qr-designs

Field	Type	Required	Description
content	—
previewUrl	string
publicOrder	integer
typology	QrTypology (IRI)
createdAt	date-time

Qr Logo

/api/qr-logos

Field	Type	Required	Description
assetUrl	string
isTemplate	boolean
timesUsed	integer

Qr Style

/api/qr-styles/_draft

Field	Type	Required	Description
design	QrDesign (IRI)
logo	QrLogo (IRI)
designParams	—
imageUrl	string
updatedAt	date-time

Theme

/api/themes

Field	Type	Required
data	—	yes
account	Account (IRI)
isSysDefault	boolean
listOrder	integer
previewContent	string

Organising your codes

Project

/api/projects

Field	Type	Required	Description
title	string	yes	Human-friendly project title
state	integer		Project state: 0 (active), 1 (paused), 2 (archived)
createdAt	date-time
updatedAt	date-time
isActive	boolean

Tag

/api/tags

Field	Type	Required	Description
name	string	yes
account	Account (IRI)

Domain

/api/domains

Field	Type	Required
name	string	yes
isSysReserved	boolean
displayName	string
allowCreation	boolean

Trash List

/api/trash-lists

Field	Type	Required	Description
uuid	string
entityType	string
title	string
assetUrl	string
deleted	string
project	—

Account and access

Api Key

/api/api-keys

Field	Type	Required	Description
prefix	string
last4	string
name	string
revoked	boolean
expiresAt	date-time
lastUsedAt	date-time
createdAt	date-time
maskedValue	string

User Account

/api/user-accounts

Field	Type	Required
allowedProjects	Project (IRI)
createdBy	User (IRI)
user	User (IRI)
account	Account (IRI)
isOwner	boolean
status	string
invitation	Invitation (IRI)
group	Group (IRI)	yes
name	string
logo	string

Account

/api/accounts

Field	Type	Required
status	integer
subscriptionStatus	integer
workflowStatus	string
subscriptionType	integer
expirationDate	date-time
planPrice	PlanPrice (IRI)	yes
billingInfo	BillingInfo (IRI)
invoices	Invoice (IRI)
paymentSources	PaymentSource (IRI)
owner	User (IRI)
projects	Project (IRI)
detail	AccountDetail (IRI)
tags	Tag (IRI)
subscription	AccountSubscription (IRI)
lastPaymentDate	date-time
lastStatusDate	date-time
trialBeganAt	date-time
totals	string
hasCreatedFirstQr	boolean
isFirstScanReceived	boolean
hasCreatedFirstProject	boolean
features	—
metadata	—
createdAt	date-time
updatedAt	date-time
statusDescription	string
subscriptionStatusDescription	string
subscriptionTypeDescription	string

User

/api/users

Field	Type	Required
location	—
browserLocale	string
referrer	string
email	string	yes
password	string
name	string
lastName	string
firstName	string
locale	string
lastLogin	date-time
timezone	string
isEnabled	boolean
isSocialCreated	boolean
avatar	Asset (IRI)
phone	string
metadata	—
createdAt	date-time
shortLocale	string

Group

/api/groups

Field	Type	Required	Description
name	string
permissions	—

Plans and billing

Plan

/api/plans

Field	Type	Required
name	string	yes
displayName	string	yes
displayDescription	string
isPremium	boolean
isActive	boolean
visible	boolean
hasTrial	boolean
parent	Plan (IRI)
level	integer
features	—
publicDisplay	boolean
prices	—
isChild	boolean

Plan Price

/api/plan-prices

Field	Type	Required
name	string	yes
displayName	string	yes
months	integer	yes
plan	Plan (IRI)	yes
currency	integer
isActive	boolean
discount	Discount (IRI)
visible	boolean
subscriptionBadge	string
features	—
price	number
originalPrice	number
originalMonthlyPrice	number
monthlyPrice	number
renewDate	date-time

Invoice

/api/invoices

Field	Type	Required	Description
code	string
name	string
lastName	string
transactionId	string
paymentMethod	integer
amount	string
currency	integer
description	string
internalNotes	string
legalId	string
city	string
country	string
postalCode	string
email	string
phone	string
addressLine1	string
addressLine2	string
isActive	boolean
observation	string
uuid	—
createdAt	date-time
downloadUrl	string
address	string
amountDescription	string
currencyDescription	string

Order

/api/orders-schedule

Field	Type	Required
months	integer
amount	string
status	integer
type	integer
planPrice	PlanPrice (IRI)
account	Account (IRI)	yes
user	User (IRI)
orderPayment	OrderPayment (IRI)
currency	integer
token	string
statusMsg	string
discount	Discount (IRI)
scheduledTo	date-time
invoice	Invoice (IRI)
createdAt	date-time
updatedAt	date-time
fullAmount	string
totalAmount	string
statusDescription	string
typeDescription	string
currencyCode	string

Order Payment

/api/order-payments

Field	Type	Required
method	integer	yes
transactionId	string
relatedOrder	Order (IRI)	yes
extra	—

Payment Source

/api/payment-sources

Field	Type	Required
type	integer
info	—
expirationDate	date-time
isDefault	boolean
account	Account (IRI)	yes
uuid	—
isValid	boolean

Payment Transaction

/api/payment-transactions

Field	Type	Required	Description
merchantPaymentAccount	MerchantPaymentAccount (IRI)
qr	Qr (IRI)
componentId	string
paymentType	string
amountCents	integer
currency	string
status	string
customerEmail	string
metadata	—
uuid	—
createdAt	date-time
amountFormatted	string

Merchant Payment Account

/api/merchant-payment-accounts

Field	Type	Required	Description
name	string
provider	string
providerDetails	—
status	string
chargesEnabled	boolean
payoutsEnabled	boolean
isDefault	boolean
default	boolean
ready	boolean
displayName	string