List links

THE CALL, PART BY PART

method

GET

host

strait.link

version

/v1

resource

/links

Auth: secret key as Authorization: Bearer. Server-side only.

Request

Without limit/cursor: every active link as a JSON array (unchanged). With either: one page { links, nextCursor }, newest first; pass nextCursor back as cursor until it is null. status=paused lists paused links instead (turned off with DELETE, PATCH isActive: false or the dashboard; links disabled for abuse are not listed), always as pages.

Parameters

limit integer query
Page size, 1–100 (larger values are capped at 100). Default 50 when paging.
cursor string query
Opaque nextCursor from the previous page.
status "active" | "paused" query
active (default) or paused. Paused links come back as pages; turn one back on with PATCH isActive: true.
tag string query
Only links with this exact tag (works with or without paging). 1–100 characters, no " or \.

Response

  • 200 Links (array), or a page when limit/cursor is given
  • 400 Invalid limit, cursor or status

The response, printed

Response 200 (no paging parameters)
[
  {
    "id": "lnk_123",
    "slug": "summer",
    "shortUrl": "https://hilltop.strait.link/summer",
    "longUrl": "https://shop.example.com/product/42",
    "tenantId": "string",
    "isActive": true,
    "iosFallbackUrl": "https://shop.example.com/product/42",
    "androidFallbackUrl": "https://shop.example.com/product/42",
    "desktopUrl": "https://shop.example.com/product/42",
    "webTapId": true,
    "description": "string",
    "imageUrl": "https://shop.example.com/product/42",
    "campaign": "string",
    "health": {
      "status": "ok",
      "problems": [
        {}
      ],
      "checkedAt": "2026-01-01T00:00:00.000Z"
    },
    "variants": [
      {
        "url": "https://shop.example.com/product/42",
        "weight": 1
      }
    ],
    "passwordProtected": false,
    "blockedReason": "string",
    "title": "Summer sale",
    "tags": [
      "spring"
    ],
    "expiresAt": null,
    "expiredAction": "page",
    "expiredUrl": null,
    "startsAt": 1,
    "notLiveAction": "page",
    "notLiveUrl": null,
    "countryRules": [
      {
        "countries": [
          "IN",
          "BD"
        ],
        "url": "https://shop.example.com/product/42"
      }
    ],
    "legacyHost": "acme.page.link",
    "legacyCode": "aBcD",
    "referralCode": "string"
  }
]
Response 200 (with limit or cursor)
{
  "links": [
    {
      "id": "lnk_123",
      "slug": "summer",
      "shortUrl": "https://hilltop.strait.link/summer",
      "longUrl": "https://shop.example.com/product/42",
      "tenantId": "string",
      "isActive": true,
      "iosFallbackUrl": "https://shop.example.com/product/42",
      "androidFallbackUrl": "https://shop.example.com/product/42",
      "desktopUrl": "https://shop.example.com/product/42",
      "webTapId": true,
      "description": "string",
      "imageUrl": "https://shop.example.com/product/42",
      "campaign": "string",
      "health": {
        "status": "ok",
        "problems": [
          {}
        ],
        "checkedAt": "2026-01-01T00:00:00.000Z"
      },
      "variants": [
        {
          "url": "https://shop.example.com/product/42",
          "weight": 1
        }
      ],
      "passwordProtected": false,
      "blockedReason": "string",
      "title": "Summer sale",
      "tags": [
        "spring"
      ],
      "expiresAt": null,
      "expiredAction": "page",
      "expiredUrl": null,
      "startsAt": 1,
      "notLiveAction": "page",
      "notLiveUrl": null,
      "countryRules": [
        {
          "countries": [
            "IN",
            "BD"
          ],
          "url": "https://shop.example.com/product/42"
        }
      ],
      "legacyHost": "acme.page.link",
      "legacyCode": "aBcD",
      "referralCode": "string"
    }
  ],
  "nextCursor": "WyIyMDI2LTAxLTAxVDAwOjAwOjAwWiIsImxua18xMjMiXQ"
}