Skip to content

API reference

Get a link

Look up a short link in your personal workspace by its alias.

GEThttps://ishortn.ink/api/v1/links/{alias}

Returns the destination and settings of one short link.

Request

ParameterInTypeRequiredDescription
aliaspathstringYesThe link's alias, such as launch-day.
domainquerystringNoThe link's domain. Defaults to your default domain, or isht.app. See Domains.
curl "https://ishortn.ink/api/v1/links/launch-day?domain=isht.app" \
  -H "x-api-key: YOUR_API_KEY"

Response

200 OK with the link.

FieldTypeDescription
shortLinkstringThe full short URL, https://<domain>/<alias>.
urlstringThe destination URL.
aliasstringThe alias.
expiresAtstring | nullWhen the link expires, or null.
activatesAtstring | nullWhen the link starts redirecting, or null.
expiresAfternumber | nullClick limit, or null.
{
  "shortLink": "https://isht.app/launch-day",
  "url": "https://example.com/blog/launch-day",
  "alias": "launch-day",
  "expiresAt": "2026-12-31T23:59:59.000Z",
  "activatesAt": null,
  "expiresAfter": null
}

Errors

StatusBodyCause
401Invalid or missing API keySee Authentication.
403Domain not available for this API keydomain isn't a platform domain or an active custom domain in your personal workspace.
404Link not foundNo link with that alias on that domain in your personal workspace.
429Rate limit exceeded. Retry in N seconds.See Rate limits.

Something missing or unclear? Email support@ishortn.ink.