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
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
alias | path | string | Yes | The link's alias, such as launch-day. |
domain | query | string | No | The 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.
| Field | Type | Description |
|---|---|---|
shortLink | string | The full short URL, https://<domain>/<alias>. |
url | string | The destination URL. |
alias | string | The alias. |
expiresAt | string | null | When the link expires, or null. |
activatesAt | string | null | When the link starts redirecting, or null. |
expiresAfter | number | null | Click 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
| Status | Body | Cause |
|---|---|---|
401 | Invalid or missing API key | See Authentication. |
403 | Domain not available for this API key | domain isn't a platform domain or an active custom domain in your personal workspace. |
404 | Link not found | No link with that alias on that domain in your personal workspace. |
429 | Rate limit exceeded. Retry in N seconds. | See Rate limits. |
Something missing or unclear? Email support@ishortn.ink.