Skip to main content
GET
List short links with pagination

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

Query Parameters

domainIds
array

Filter by domain UUIDs

Example:
folderIds
array

Filter by folder UUIDs

Example:
tagIds
array

Filter by tag UUIDs

Example:
withQrCodeTemplate
boolean | null
default:false

Include QR code data in response

Example:

false

limit
number | null
default:25

Maximum number of items to return per page

Required range: 0 <= x <= 50
Example:

25

page
number | null
default:0

Page number for pagination (zero-indexed)

Required range: x >= 0
Example:

0

Search query string to filter results

Example:

"example"

Response

Paginated short links retrieved successfully

count
number
required

Total number of items matching the query

Required range: x >= 0
Example:

42

data
object[]
required