Retrieve short link details

Retrieves details of a shortened link using its alias.

GET /links/{alias}

Try it

Retrieve link details

cURL

curl --request GET \
  --url https://ishortn.ink/api/v1/links/{alias} \
  --header 'x-api-key: <api-key>'

200

{
  "shortLink": "<string>",
  "url": "<string>",
  "alias": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "expiresAfter": 123,
  "isProtected": true
}

Authorizations

x-api-key · string · header · required

Path Parameters

alias · string · required

The alias of the shortened link.

Query Parameters

domain · string

The domain of the shortened link. If not provided, the default domain will be used.

Response

200

application/json

Link details retrieved successfully

shortLink · string

The shortened link.

url · string

The original URL.

alias · string

The alias of the shortened link.

expiresAt · string<date-time> | null

The expiration date and time of the link.

expiresAfter · integer | null

The number of clicks after which the link expires.

isProtected · boolean

Indicates if the link is password protected (relevant for creation response).