GET
/
qrcodes
JavaScript
import Codeqr from '@codeqr/ts';

const client = new Codeqr({
  apiKey: 'My API Key',
});

const qrCodes = await client.qrcodes.list();

console.log(qrCodes);
[
  {
    "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

​
id
string
required

The unique ID of the QR code.

​
domain
string
required

The domain of the QR code. If not provided, the main domain of the project will be used (or codeqr.link if the project does not have domains).

​
key
string
required

The slug of the QR code. If not provided, a random slug of 7 characters will be generated.

​
archived
boolean
default:false
required

If the QR code is archived.

​
expiresAt
string | null
required

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

​
expiredUrl
string | null
required

The destination URL when the QR code expires.

​
password
string | null
required

The password required to access the destination URL of the QR code.

​
externalId
string | null
required

The external ID associated with the QR code.

​
trackConversion
boolean
default:false
required

[BETA] If should track conversions for the QR code.

​
proxy
boolean
default:false
required

If the QR code uses the custom link preview feature.

​
title
string | null
required

The title of the QR code generated via api.codeqr.io/metatags. Will be used for custom link preview if proxy is true.

​
description
string | null
required

The description of the QR code generated via api.codeqr.io/metatags. Will be used for custom link preview if proxy is true.

​
image
string | null
required

The image of the QR code generated via api.codeqr.io/metatags. Will be used for custom link preview if proxy is true.

​
utm_source
string | null
required

The source UTM of the QR code.

​
utm_medium
string | null
required

The medium UTM of the QR code.

​
utm_campaign
string | null
required

The campaign UTM of the QR code.

​
utm_term
string | null
required

The term UTM of the QR code.

​
utm_content
string | null
required

The content UTM of the QR code.

​
rewrite
boolean
default:false
required

If the QR code uses link cloaking.

​
doIndex
boolean
default:false
required

If the QR code should be indexed.

​
flexible
boolean
default:false
required

If the QR code is flexible.

​
filled
boolean
default:false
required

If the QR code is filled.

​
ios
string | null
required

The destination URL for iOS for the QR code for device targeting iOS.

​
android
string | null
required

The destination URL for Android for the QR code for device targeting Android.

​
geo
object | null
required

Geographic segmentation information for the QR code in the JSON format {[COUNTRY]: https://example.com }. Learn more: https://codeqr.link/geo

​
static
boolean
default:false
required

If the QR code is static.

​
type
enum<string>
required

The type of the QR code.

Available options:
url,
text,
email,
wifi,
phone,
vcard,
crypto,
sms,
facetime,
latlog,
pix
​
contentStatic
string | null
required

The static content of the QR code.

​
text
string | null
required

The text of the QR code.

​
email
object | null
required

The email information of the QR code.

​
wifi
object | null
required

The WiFi information of the QR code.

​
url
string | null
required

The URL of the QR code.

​
phone
string | null
required

The phone number of the QR code.

​
vcard
object | null
required

The vCard information of the QR code.

​
crypto
object | null
required

The cryptocurrency information of the QR code.

​
sms
object | null
required

The SMS information of the QR code.

​
facetime
object | null
required

The FaceTime information of the QR code.

​
latlog
object | null
required

The latitude and longitude information of the QR code.

The logo of the QR code.

​
bgColor
string
required

The background color of the QR code.

​
fgColor
string
required

The foreground color of the QR code.

​
size
number
required

The size of the QR code.

​
level
string
required

The level of error correction of the QR code.

If the logo should be displayed in the QR code.

​
src
string | null
required

The source of the QR code.

​
height
number
required

The height of the QR code.

​
width
number
required

The width of the QR code.

​
excavate
boolean
default:false
required

If the QR code should be excavated.

​
userId
string | null
required

The ID of the user that created the QR code.

​
projectId
string | null
required

The ID of the project of the QR code.

​
publicStats
boolean
default:false
required

If the statistics of the QR code are publicly accessible.

​
scans
number
default:0
required

The number of scans of the QR code.

​
lastClicked
string | null
required

The date and time the QR code was scanned last.

​
leads
number
default:0
required

The number of leads generated by the QR code.

​
sales
number
default:0
required

The number of sales generated by the QR code.

​
saleAmount
number
default:0
required

The amount of the sale generated by the link.

​
createdAt
string
required

The date and time the QR code was created.

​
updatedAt
string
required

The date and time the QR code was updated last.

​
tagId
string | null
required
deprecated

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

​
tags
Tag · object[] | null
required

The tags assigned to the QR code.

​
comments
string | null
required

The comments for the QR code.

​
notificationToken
string | null
required

The notification token of the QR code.

​
preRedirection
boolean
default:false
required

If the QR code has pre-redirection.

​
isFormMandatory
boolean
default:false
required

If the form is mandatory for the page.

​
pageId
string | null

The ID of the page to redirect to before the QR code destination.

​
pageUrl
string | null

The URL of the page to redirect to before the QR code destination.