GET/api/v1/links/:id

Get a link

Returns the full detail object for a single link, including routing rules, tracking settings, and QR code info.

Authorization

Authorizationstringheaderrequired

Bearer token. Format: Bearer YOUR_API_KEY

Path Parameters

idstringpathrequired

The ID of the link to retrieve.

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

{
"link": {
  "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",
  "updatedAt": "2024-06-15T08:30:00.000Z",
  "description": "Our biggest sale of the year",
  "image": null,
  "password": null,
  "expiresAt": "2024-07-01T00:00:00.000Z",
  "maxClicks": 10000,
  "cloaked": false,
  "redirectType": "302",
  "workspaceId": "ws_abc123",
  "forwardParameters": false,
  "blockBots": true,
  "skipSocialCrawlerTracking": false,
  "hideReferrer": false,
  "metaPixelId": "123456789",
  "googleTagId": null,
  "gtmContainerId": null,
  "headTags": null,
  "bodyTags": null,
  "webhookUrls": null,
  "tags": [
    { "tag": { "id": "tag_123", "name": "summer", "color": "#3b82f6" } }
  ],
  "qrCode": null,
  "rules": [],
  "createdBy": {
    "id": "user_abc",
    "name": "Jane Smith",
    "email": "jane@mycompany.com"
  }
}
}