GET
/
qrcodes
Retrieve a list of QR Codes
curl --request GET \
  --url https://api.codeqr.io/qrcodes \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "domain": "<string>",
    "key": "<string>",
    "archived": false,
    "expiresAt": "<string>",
    "expiredUrl": "<string>",
    "password": "<string>",
    "externalId": "<string>",
    "trackConversion": false,
    "proxy": false,
    "title": "<string>",
    "description": "<string>",
    "image": "<string>",
    "utm_source": "<string>",
    "utm_medium": "<string>",
    "utm_campaign": "<string>",
    "utm_term": "<string>",
    "utm_content": "<string>",
    "rewrite": false,
    "doIndex": false,
    "flexible": false,
    "filled": false,
    "ios": "<string>",
    "android": "<string>",
    "geo": {},
    "static": false,
    "type": "url",
    "contentStatic": "<string>",
    "text": "<string>",
    "email": {},
    "wifi": {},
    "url": "<string>",
    "phone": "<string>",
    "vcard": {},
    "crypto": {},
    "sms": {},
    "facetime": {},
    "latlog": {},
    "logo": "<string>",
    "bgColor": "<string>",
    "fgColor": "<string>",
    "size": 123,
    "level": "<string>",
    "showLogo": false,
    "src": "<string>",
    "height": 123,
    "width": 123,
    "excavate": false,
    "userId": "<string>",
    "projectId": "<string>",
    "publicStats": false,
    "scans": 0,
    "lastClicked": "<string>",
    "leads": 0,
    "sales": 0,
    "saleAmount": 0,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "tagId": "<string>",
    "tags": [
      {
        "id": "<string>",
        "name": "<string>",
        "color": "red"
      }
    ],
    "comments": "<string>",
    "notificationToken": "<string>",
    "preRedirection": false,
    "pageId": "<string>",
    "pageUrl": "<string>",
    "isFormMandatory": false
  }
]

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Query Parameters

​
projectSlug
string

The slug of the project to which the QR code belongs. For example, for app.codeqr.io/acme, the projectSlug is acme.

​
domain
string

The domain to filter the QR codes. For example, ac.me. If not provided, all QR codes of the project will be returned.

​
tagId
string
deprecated

[DEPRECATED (use tagIds instead)]: The unique ID of the tag assigned to the QR code.

​
tagIds

The IDs of the tags to filter the QR codes.

​
tagNames

The unique name of the tags assigned to the QR code (case insensitive).

​
search
string

The search term to filter the QR codes. The search term will be matched against the QR code slug and the destination URL.

​
userId
string

The ID of the user to filter by.

​
showArchived
boolean
default:false

If should include archived QR codes in the response. The default is false if not provided.

​
comments
string

The comments to filter by.

​
password
string

The password to filter by.

​
expiresAt
string<date-time> | null

The date and time the QR code will expire in ISO-8601 format. Must be in the future.

​
trackConversion
boolean
default:false

If should include QR codes with conversion tracking enabled. The default is false if not provided.

​
withTags
boolean
default:false

If should include tags in the response. The default is false if not provided.

​
format
enum<string>

Filter by QR code format - static or dynamic

Available options:
static,
dynamic
​
type
enum<string>

Filter by QR code type

Available options:
url,
text,
email,
wifi,
phone,
vcard,
crypto,
sms,
facetime,
latlog,
pix
​
hasPassword
boolean

Filter QR codes with/without password protection

​
hasExpiration
boolean

Filter QR codes with/without expiration date

​
hasUTM
boolean

Filter QR codes with/without UTM parameters

​
hasCustomSocial
boolean

Filter QR codes with/without custom social media cards

​
hasGeo
boolean

Filter QR codes with/without geo-targeting

​
hasDevice
boolean

Filter QR codes with/without device targeting

​
hasComments
boolean

Filter QR codes with/without comments

​
hasTags
boolean

Filter QR codes with/without tags

​
createdAfter
string<date-time>

Filter QR codes created after this date

​
createdBefore
string<date-time>

Filter QR codes created before this date

​
expiresAfter
string<date-time>

Filter QR codes expiring after this date

​
expiresBefore
string<date-time>

Filter QR codes expiring before this date

​
scansMin
integer

Minimum number of scans

Required range: x >= 0
​
scansMax
integer

Maximum number of scans

Required range: x >= 0
​
sort
enum<string>
default:createdAt

The field to order the QR codes. The default is createdAt, and the order of sorting is always descending.

Available options:
createdAt,
scans,
lastClicked
​
page
number
default:1

The page number for pagination.

Required range: x > 0
Example:

1

​
pageSize
number
default:100

The number of items per page.

Required range: 0 < x <= 100
Example:

50

Response

A list of QR Codes

The response is of type QRCode · object[].