List your links

You can access your branded short links collection with an HTTP GET on the links endpoint https://app.linksgpt.com/api/v1/links

REQUEST EXAMPLE

cURL

curl 'https://app.linksgpt.com/api/v1/links?page=1&limit=10&tags=tag1&domainId=1664552993913047093' \
-X GET \
-H 'apikey: YOUR_API_KEY' \
-H 'Accept: application/json' \
-H 'Accept-Language: en'

PATH PARAMETERS

Parameter	Constraints	Description
id	required	Unique identifier of the branded short link you want to get.

QUERY PARAMETERS

Parameter	Constraints	Description
page	required	Current page.
limit	required	How many short links to load.
domainId	required	Filter short links which refer to a specific branded domain id. You can call List your domains to get the domain id.
sort	optional	Sorting criteria to apply to your short links collection. Example: sort=createdAt desc
filter	optional	Filter short links according to title or link.
tags	optional	Filter short links according to tags. Example: tags=tag1,tag2,tag3
workspace	optional	Your workspace id, if you do not specify the workspace context, the default workspace (your main workspace) will be used. If apikey is used as the authentication mode, you do not need to set this parameter.

RESPONSE EXAMPLE

JSON

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "id": "1681896527355709345",
      "workspaceId": "7e3ydi936o",
      "domainId": "1664552993913047093",
      "domainName": "demo.xxxx.com",
      "title": "LinksGPT",
      "path": "jEmQ",
      "link": "https://demo.xxxx.com/jEmQ",
      "file": "demo.xxxx.com/jEmQ",
      "recordType": "301",
      "destination": "https://www.linksgpt.com",
      "utm": {
        "source": "facebook",
        "medium": "ad",
        "campaign": "summer_sale",
        "content": "image_ad1"
      },
      "tags": [],
      "createdAt": "2023-06-20 13:19:14",
      "updatedAt": "2023-06-20 13:19:14"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://app.linkxbi.com/api/v1/links",
    "per_page": 10,
    "to": 1,
    "total": 1
  }
}

See more HTTP Responses

RESPONSE DATA

An array of object.

Property	Type	Description
id	string	Unique identifier of the branded short link.
workspaceId	string	The workspace id to which the short link belongs.
domainId	string	The domain id to which the short link belongs.
domainName	string	The domain name to which the short link belongs.
title	string	A title you assign to the short link in order to remember what's behind it.
path	string	The keyword portion of your branded short link.
link	string	Full brand short link.
file	string	The brand short link without http schema.
recordType	string	URL redirect type.
destination	string	The destination URL your branded short link pointed to.
utm	object	UTM params.
tags	array of strings	Unique identifier of the Tag resource. Returns an empty array in the list api. If you want to get tags of a brand short link, call Get link detail.
createdAt	string	Created time.
updatedAt	string	Last updated time.