GET
/
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
  }
]

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Query Parameters

​
projectSlug
string

O slug do projeto ao qual o link pertence. Por exemplo, para app.codeqr.io/acme, o projectSlug é acme.

​
domain
string

O domínio para filtrar os links. Por exemplo, ac.me. Se não for fornecido, todos os links do projeto serão retornados.

​
tagId
string
deprecated

[OBSOLETO (use tagIds em vez disso)]: O ID único da tag atribuída ao link curto.

​
tagIds

Os IDs das tags para filtrar os links.

​
tagNames

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

​
search
string

O termo de pesquisa para filtrar os links. O termo de pesquisa será correspondido contra o slug do link curto e a URL de destino.

​
userId
string

O ID do usuário para filtrar os links.

​
showArchived
boolean
default:false

Se deve incluir links arquivados na resposta. O padrão é false se não for fornecido.

​
withTags
boolean
default:false

Se deve incluir tags na resposta. O padrão é false se não for fornecido.

​
trackConversion
boolean
default:false

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

​
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

200
application/json

A list of links

The response is of type Link · object[].