GET/api/v6/urlshortener/links

List short links

Your links, newest first, with their click counters. Paginated.

Scope

API key with the urlshortener service enabled

Usage limit

30 requests per minute

Up to 100 items per page.

Lists your short links, newest first, with click counters already consolidated on each item.

Query parameters

page

integeroptional

1-based page number.

Default: 1

perPage

integeroptional

Items per page (max 100).

Default: 20

active

booleanoptional

Filter by active state.

domain

stringoptional

Filter by domain.

search

stringoptional

Substring match on the code or the destination URL (minimum 2 characters).

Responses

200

Page of links.

{
  "success": true,
  "data": {
    "items": [
      {
        "id": 1024,
        "code": "a1b2c3d",
        "domain": "go.acme.co",
        "shortUrl": "https://go.acme.co/a1b2c3d",
        "longUrl": "https://example.com/landing",
        "active": true,
        "expiresAt": null,
        "createdAt": "2026-06-01T15:04:05Z",
        "clicks": 128,
        "uniqueClicks": 96,
        "lastClickAt": "2026-06-01T18:22:10Z"
      }
    ],
    "page": 1,
    "perPage": 20,
    "total": 1,
    "hasMore": false
  },
  "meta": {
    "requestId": "8f0c0e2a4b1d4c8fae2b7a91e0c5d3f6",
    "timestamp": "2026-06-01T18:30:00+00:00",
    "responseTimeMs": 5.1
  }
}

401

Invalid or missing credentials.

429

Request limit exceeded.

Possible errors

Codes this endpoint can return in error.code. The full detail lives in the catalog.

401AUTH_REQUIREDNo Bearer token was sent, and every call requires one.401AUTH_INVALID_KEYThe API key is not recognized: wrong format, revoked or expired.401AUTH_SERVICE_NOT_ALLOWEDThe key is not allowed to use the service behind this endpoint.429RATE_TPS_EXCEEDEDYou exceeded your organization quota for this endpoint.

See the full catalog

Scope and limits

Query parameters

Responses

Possible errors