Skip to main content
GET
https://api.bouncy.ai
/
v1
/
links
curl https://api.bouncy.ai/v1/links?page=1&limit=50&sortBy=clicks&order=desc \
  -H "X-Api-Key: bcy_live_pk_YOUR_API_KEY"

{
  "data": [
    {
      "id": "link_abc123",
      "shortUrl": "https://bouncy.link/summer",
      "slug": "summer",
      "destination": "https://example.com/summer-sale",
      "title": "Summer Sale 2026",
      "description": "50% off everything",
      "tags": ["marketing", "sale"],
      "domain": "bouncy.link",
      "createdAt": "2026-02-01T12:00:00Z",
      "updatedAt": "2026-02-05T10:30:00Z",
      "enabled": true,
      "clicks": 1234
    },
    {
      "id": "link_def456",
      "shortUrl": "https://bouncy.link/promo",
      "slug": "promo",
      "destination": "https://example.com/promo",
      "title": "Special Promotion",
      "tags": ["marketing"],
      "domain": "bouncy.link",
      "createdAt": "2026-01-28T15:20:00Z",
      "updatedAt": "2026-02-03T09:15:00Z",
      "enabled": true,
      "clicks": 876
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "totalCount": 245,
    "totalPages": 5,
    "hasMore": true
  }
}

​
Request

​
Headers

​
X-Api-Key
string
required
Your API key (e.g., bcy_live_pk_YOUR_API_KEY)

​
Query Parameters

​
page
integer
default:"1"
Page number for paginationExample: 1
​
limit
integer
default:"50"
Number of links per page (max: 100)Example: 50
​
sortBy
string
default:"createdAt"
Field to sort byOptions: createdAt, updatedAt, clicks Example: clicks
​
order
string
default:"desc"
Sort orderOptions: asc, desc Example: desc
​
search
string
Search in titles, slugs, and URLsExample: summer
​
tag
string
Filter by tagExample: marketing
​
groupId
string
Filter by group IDExample: grp_abc123
​
domain
string
Filter by domainExample: bouncy.link

​
Response

​
data
array
Array of link objects
​
pagination
object
Pagination metadata
curl https://api.bouncy.ai/v1/links?page=1&limit=50&sortBy=clicks&order=desc \
  -H "X-Api-Key: bcy_live_pk_YOUR_API_KEY"

{
  "data": [
    {
      "id": "link_abc123",
      "shortUrl": "https://bouncy.link/summer",
      "slug": "summer",
      "destination": "https://example.com/summer-sale",
      "title": "Summer Sale 2026",
      "description": "50% off everything",
      "tags": ["marketing", "sale"],
      "domain": "bouncy.link",
      "createdAt": "2026-02-01T12:00:00Z",
      "updatedAt": "2026-02-05T10:30:00Z",
      "enabled": true,
      "clicks": 1234
    },
    {
      "id": "link_def456",
      "shortUrl": "https://bouncy.link/promo",
      "slug": "promo",
      "destination": "https://example.com/promo",
      "title": "Special Promotion",
      "tags": ["marketing"],
      "domain": "bouncy.link",
      "createdAt": "2026-01-28T15:20:00Z",
      "updatedAt": "2026-02-03T09:15:00Z",
      "enabled": true,
      "clicks": 876
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "totalCount": 245,
    "totalPages": 5,
    "hasMore": true
  }
}