GET
/
links
/
info
Retrieve a link
curl --request GET \
  --url https://api.codeqr.io/links/info \
  --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
}
You can retrieve a link by providing one of the following as a query parameter:
  • domain and key.
  • linkId.
  • externalId.

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Query Parameters

​
projectSlug
string
required

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

Minimum length: 1
​
domain
string
required

O domínio do link a ser recuperado. Por exemplo, para codeqr.link/github, o domínio é codeqr.link.

Minimum length: 1
​
key
string
required

A chave do link a ser recuperado. Por exemplo, para codeqr.link/github, a chave é github.

Minimum length: 1
​
linkId
string

The unique ID of the short link.

Example:

"clux0rgak00011..."

​
externalId
string

Este é o ID do link no seu banco de dados. Deve ser prefixado com ext_ quando passado como um parâmetro de consulta.

Example:

"ext_123456"

Response

200
application/json

The retrieved link

The response is of type object.