Skip to main content
GET
Get short link details

Authorizations

x-api-key
string
header
required

API Key authentication for programmatic access.

How to use:

  1. Create an API key from your dashboard settings
  2. Include the key in the x-api-key header with each request
  3. API keys have granular permissions (domains, shortLinks, files, stats, apiKeys)

Example:

Types of API keys:

  • User keys: Linked to your user account (one per organization)
  • Bot keys: Autonomous machine users (one per organization)

Security notes:

  • Keep your API keys secure and never commit them to version control
  • API keys cannot access authentication endpoints (/auth/*)
  • Keys can be revoked at any time from the dashboard

Path Parameters

id
string<uuid>
required

Unique identifier in UUID v7 format

Example:

"01933eb8-541f-7000-a9f4-e4eee80ff04e"

Response

Short link details retrieved successfully

Complete short link with all nested objects

domain
object
required

Domain details

rules
object[]
required

Smart routing rules with IDs

qrCode
object | null
required

QR code configuration

destination
object | null
required

Main destination configuration

Example:
metaTags
object | null
required

Meta tags configuration

Example:
tags
object[]
required

Associated tags

id
string<uuid>
required

Short link UUID

Example:

"01933eb8-541f-7000-a9f4-e4eee80ff04e"

organizationId
string<uuid>
required

Organization UUID

Example:

"01933eb8-541f-7000-a9f4-e4eee80ff04e"

isActive
boolean
required

Whether link is active

Example:

true

qrCodeId
string<uuid> | null
required

QR code configuration UUID

Example:

"01933eb8-541f-7000-a9f4-e4eee80ff04e"

domainId
string<uuid>
required

Domain UUID

Example:

"01933eb8-541f-7000-a9f4-e4eee80ff04e"

folderId
string<uuid> | null
required

Folder UUID

Example:

"01933eb8-541f-7000-a9f4-e4eee80ff04e"

slug
string
required

Short link slug

Example:

"summer-sale"

originUrl
string<uri>
required

Complete short URL

Example:

"https://links.example.com/summer-sale"

expiresAt
string<date-time> | null
required

Expiration timestamp

Example:

"2024-12-31T23:59:59Z"

maxClicks
number | null
required

Maximum click limit

Example:

1000

currentClicks
number
required

Current click count

Required range: x >= 0
Example:

247

hasPassword
boolean
required

Whether link is password protected

Example:

false

cloaking
boolean
required

Whether destination is hidden

Example:

false

destinationId
string<uuid>
required

Destination configuration UUID

Example:

"01933eb8-541f-7000-a9f4-e4eee80ff04e"

createdAt
string<date-time>
required

Creation timestamp

Example:

"2024-01-15T10:30:00Z"

updatedAt
string<date-time>
required

Last update timestamp

Example:

"2024-01-16T14:20:00Z"