GET
/
links
Retrieve a list of links
curl --request GET \
  --url https://api.codeqr.io/links \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "domain": "<string>",
    "key": "<string>",
    "url": "<string>",
    "archived": false,
    "expiresAt": "<string>",
    "expiredUrl": "<string>",
    "trackConversion": false,
    "flexible": false,
    "doIndex": false,
    "password": "<string>",
    "externalId": "<string>",
    "proxy": false,
    "title": "<string>",
    "description": "<string>",
    "image": "<string>",
    "video": "<string>",
    "rewrite": false,
    "ios": "<string>",
    "android": "<string>",
    "geo": {},
    "publicStats": false,
    "tagId": "<string>",
    "tags": [
      {
        "id": "<string>",
        "name": "<string>",
        "color": "red"
      }
    ],
    "comments": "<string>",
    "notificationToken": "<string>",
    "shortLink": "<string>",
    "qrCode": "<string>",
    "utm_source": "<string>",
    "utm_medium": "<string>",
    "utm_campaign": "<string>",
    "utm_term": "<string>",
    "utm_content": "<string>",
    "userId": "<string>",
    "projectId": "<string>",
    "clicks": 0,
    "leads": 0,
    "sales": 0,
    "saleAmount": 0,
    "lastClicked": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "preRedirection": false,
    "pageId": "<string>",
    "pageUrl": "<string>",
    "isFormMandatory": false,
    "filled": false
  }
]

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Query Parameters

​
projectSlug
string

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

​
domain
string

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

​
tagId
string
deprecated

[OBSOLETO (use tagIds em vez disso)]: The unique ID of the tag assigned to the short link.

​
tagIds

The IDs of the tags to filter the links.

​
tagNames

The unique name of the tags assigned to the short link (case insensitive).

​
search
string

The search term to filter the links. The search term will be matched against the short link slug and the destination URL.

​
userId
string

The ID of the user to filter by.

​
showArchived
boolean
default:false

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

​
password
string

The password to filter by.

​
expiresAt
string<date-time> | null

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

​
geo
object | null

Geographic segmentation information for the short link in JSON format {[COUNTRY]: https://example.com }.

​
ios
string

The iOS device to filter by.

​
android
string

The Android device to filter by.

​
comments
string

The comments to filter by.

​
withTags
boolean
default:false

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

​
trackConversion
boolean
default:false

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

​
hasPassword
boolean

Filter links that have password protection (any password)

​
hasExpiration
boolean

Filter links that have expiration date (any expiration)

​
hasUTM
boolean

Filter links that have UTM parameters

​
hasCustomSocial
boolean

Filter links that have custom social media cards

​
hasGeo
boolean

Filter links that have geo-targeting

​
hasDevice
boolean

Filter links that have device targeting

​
hasComments
boolean

Filter links that have comments (any comments)

​
hasTags
boolean

Filter links that have tags (any tags)

​
createdAfter
string<date-time>

Created after date (ISO string)

​
createdBefore
string<date-time>

Created before date (ISO string)

​
expiresAfter
string<date-time>

Expires after date (ISO string)

​
expiresBefore
string<date-time>

Expires before date (ISO string)

​
clicksMin
integer

Minimum number of clicks

Required range: x >= 0
​
clicksMax
integer

Maximum number of clicks

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

The field to sort the links by. The default is createdAt, and sort order is always descending.

Available options:
createdAt,
clicks,
lastClicked
​
linkIds

Link IDs to filter by.

​
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 links

The response is of type Link · object[].