GET/api/v1/links

List links

Returns a paginated list of links in your workspace. Supports filtering by domain, tag, type, and status.

Authorization

Authorizationstringheaderrequired

Bearer token. Format: Bearer YOUR_API_KEY

Query Parameters

pagenumberqueryoptional

Page number (1-indexed). Defaults to 1.

limitnumberqueryoptional

Results per page. Maximum 100. Defaults to 20.

searchstringqueryoptional

Filter by URL or title (case-insensitive substring match).

domainstringqueryoptional

Filter by domain (e.g. go.mycompany.com).

tagIdstringqueryoptional

Filter by tag ID.

isActivebooleanqueryoptional

Filter by active status. Pass true or false.

linkTypeURL | MAILTO | TEL | SMSqueryoptional

Filter by link type.

sortcreatedAt | url | clickCountqueryoptional

Field to sort by. Defaults to createdAt.

orderasc | descqueryoptional

Sort direction. Defaults to desc.

# Basic list
curl https://app.brevr.io/api/v1/links \
-H "Authorization: Bearer YOUR_API_KEY"

# Filter by domain, sorted by click count
curl "https://app.brevr.io/api/v1/links?domain=go.mycompany.com&sort=clickCount&order=desc&limit=50" \
-H "Authorization: Bearer YOUR_API_KEY"

{
"links": [
  {
    "id": "clx1abc2def3ghi4",
    "shortCode": "summer-sale",
    "url": "https://example.com/sale",
    "title": "Summer Sale",
    "domain": "go.mycompany.com",
    "linkType": "URL",
    "isActive": true,
    "clickCount": 1842,
    "createdAt": "2024-06-01T10:00:00.000Z",
    "tags": [
      { "tag": { "id": "tag_123", "name": "summer", "color": "#3b82f6" } }
    ],
    "qrCode": null
  }
],
"totalCount": 248,
"page": 1,
"limit": 20,
"totalPages": 13
}