Skip to main content
GET
Retrieve a link

Authorizations

Authorization
string
header
required

Workspace API key, sent as Authorization: Bearer lk_live_….

Path Parameters

id
string<uuid>
required

Link ID.

Response

The link.

Full link record as returned by GET /links/{id}, PATCH /links/{id}, DELETE /links/{id} and POST /links/upsert.

The stored password is a bcrypt hash and is never serialised — the boolean hasPassword is returned in its place.

id
string<uuid>
url
string

Destination URL.

Example:

"https://acme.com/pricing"

shortCode
string

Path segment of the short link.

Example:

"spring-sale"

title
string | null
Example:

"Spring campaign"

description
string | null
utmSource
string | null
Example:

"newsletter"

utmMedium
string | null
Example:

"email"

utmCampaign
string | null
Example:

"spring-2026"

utmTerm
string | null
utmContent
string | null
customUtmParams
object | null

Workspace-defined UTM parameters, keyed by parameter code.

hasPassword
boolean

true when a password gate is set on the link.

expiresAt
string<date-time> | null

After this instant the link stops redirecting.

scheduledAt
string<date-time> | null

Before this instant the link does not redirect yet.

schedulingTimezone
string | null
Example:

"Asia/Kolkata"

fallbackUrl
string | null

Used when the link is expired, not yet live, or click-limited.

clickLimit
integer | null
Example:

1000

clicks
integer
Example:

42

lastClickAt
string<date-time> | null
iosUrl
string | null

Deep link opened for iOS visitors.

androidUrl
string | null

Deep link opened for Android visitors.

geoTargets
object | null

ISO 3166-1 alpha-2 country code to destination URL.

Example:
geoTargetingEnabled
boolean
ogTitle
string | null
ogDescription
string | null
ogImage
string | null

S3 key or absolute URL of the preview image.

favicon
string | null
comments
string | null

Internal note. Never shown to visitors.

qrCodeEnabled
boolean
qrFgColor
string | null
Example:

"#000000"

qrBgColor
string | null
Example:

"#ffffff"

qrSize
integer | null
Example:

512

qrDesign
object | null
cloakingEnabled
boolean

Serve the destination inside a frame instead of redirecting.

archived
boolean
isActive
boolean
deletedAt
string<date-time> | null

Set by DELETE /links/{id}. Deleted links are never returned by list endpoints.

safetyStatus
string

Result of the destination safety scan.

Example:

"safe"

safetyCheckedAt
string<date-time> | null
safetyReason
string | null
folderId
string<uuid> | null
domainId
string<uuid> | null
templateId
string<uuid> | null
workspaceId
string<uuid>
createdById
string<uuid> | null
updatedById
string<uuid> | null
createdAt
string<date-time>
updatedAt
string<date-time>
tags
object[]
pixels
object[]
domain
object | null