Skip to main content
GET
/
links
Retrieve a list of links(QR codes)
curl --request GET \
  --url https://api.supaqr.com/links \
  --header 'Authorization: Bearer <token>'
{}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
ids
string[]

The IDs to filter the links(QR codes) by. eg. ids=id1&ids=id2

​
urls
string[]

The short links to filter the links(QR codes) by.

​
domain
string

The domain to filter the links(QR codes) by.

Minimum string length: 1
​
linkType
enum<string>

The link(QR code) type to filter the links(QR codes) by.

Available options:
link,
document,
file,
vcard,
landing-page,
google-form,
menu,
app-stores,
image,
audio,
video,
wi-fi,
email,
map,
whatsapp,
text,
sms,
svg,
code
​
tagIds
string[]

The tag IDs to filter the links(QR codes) by.

Required array length: 1 - 50 elements
​
search
string

The search term to filter the links(QR codes) by. The search term will be matched against the short link slug and the destination data.

Minimum string length: 1
​
userIds
string[]

The user ID to filter the links(QR codes) by.

Required array length: 1 - 100 elements
​
showArchived
boolean
default:false

Whether to include archived links(QR codes) in the response.

​
sortBy
enum<string>
default:createdAt

The field to sort the links(QR codes) by.

Available options:
created_at,
clicks,
last_created_at
​
sortOrder
enum<string>
default:desc

The sort order.

Available options:
desc,
asc
​
page
integer<int32>
default:1

The page number for pagination.

​
pageSize
integer<int32>
default:20

The number of links(QR codes) per page.

Required range: 1 <= x <= 100

Response

The response is of type object.