List your domains

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

REQUEST EXAMPLE

cURL

curl 'https://app.linksgpt.com/api/v1/domains' \
-X GET \
-H 'apikey: YOUR_API_KEY' \
-H 'Accept: application/json' \
-H 'Accept-Language: en'

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": "1670455313687383041",
      "domainName": "demo.xxxx.com",
      "provider": {
        "name": "cloudflare",
        "loginUrl": "https://dash.cloudflare.com/"
      },
      "rootDomainName": "xxxx.com",
      "subDomain": "demo",
      "actualDomainName": "demo.xxxx.com",
      "active": true,
      "type": 1,
      "dnsType": "CNAME",
      "dnsValue": "xxxxxxx.links-edge.com.",
      "dnsCorrect": true,
      "httpsRequested": true,
      "checkedAt": "2023-07-06 12:00:02",
      "createdAt": "2023-06-18 23:35:56",
      "updatedAt": "2023-07-06 12:00:02"
    },
    {
      "id": "1676246627343402339",
      "domainName": "z2.ink",
      "provider": {
        "name": "cloudflare",
        "loginUrl": "https://dash.cloudflare.com/"
      },
      "rootDomainName": "z2.ink",
      "subDomain": "",
      "actualDomainName": "z2.ink",
      "active": true,
      "type": 0,
      "dnsType": null,
      "dnsValue": null,
      "dnsCorrect": true,
      "httpsRequested": true,
      "checkedAt": "2023-07-14 04:00:02",
      "createdAt": "2023-07-04 23:08:33",
      "updatedAt": "2023-07-14 04:00:02"
    }
  ]
}

See more HTTP Responses

RESPONSE DATA

An array of object.

Property	Type	Description
id	string	Unique identifier of the branded domain.
domainName	string	Full name of the branded domain.
provider	object	The number of brand short links tagged with this tag.
rootDomainName	string	The root domain of the branded domain name.
subDomain	string	The sub domain part of the branded domain name.
actualDomainName	string	Actual full name of the branded domain.
active	bool	Whether the branded domain can be used or not to create branded short links.
type	integer	Branded domain type, 0: domain of platform 1: domain of user.
dnsType	string	DNS type: CNAME, TXT, A
dnsValue	string	Actual DNS value.
dnsCorrect	bool	Whether the DNS resolution is correct.
httpsRequested	bool	Whether https is supported.
checkedAt	string	DNS check time.
createdAt	string	Created time.
updatedAt	string	Last updated time.