Get link detail

Each Link object has its own URL: https://app.linksgpt.com/api/v1/links/{id}, where {id} is the unique identifier of the branded short link. To get Link object details, you should HTTP GET on the specific links endpoint, and a JSON object representing the link will be returned.

If you don't know a link's id, you can fetch it by getting the List your links.

REQUEST EXAMPLE

cURL

curl 'https://app.linksgpt.com/api/v1/links/1678662715674986986' \
-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
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": ["LinksGPT"],
        "createdAt": "2023-06-20 13:19:14",
        "updatedAt": "2023-06-20 13:19:14"
    }
}

See more HTTP Responses

RESPONSE DATA

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.
createdAt	string	Created time.
updatedAt	string	Last updated time.