v1

latestOpenAPI 3.1.02026-07-245495176.5 KB
Link queries

Link list

Get domain links

get/api/links

Query parameters

domain_idinteger required

Domain ID

limitinteger nullable
idStringstring
createdAtstring
beforeDatestring date-time
afterDatestring date-time
dateSortOrder'asc' | 'desc'
pageTokenstring
folderIdstring

Response

Default Response

countinteger required
nextPageTokenstring nullable

Example response

{
  "links": [
    {
      "originalURL": "https://example.com",
      "password": "s3cur3p@ssw0rd",
      "expiredURL": "https://example.com/expired",
      "utmSource": "cpc",
      "utmMedium": "banner",
      "utmCampaign": "summer_sale",
      "utmTerm": "running_shoes",
      "utmContent": "cta_button",
      "path": "my-link",
      "androidURL": "https://play.google.com/store/apps/details?id=com.example.app",
      "iphoneURL": "https://apps.apple.com/us/app/example-app/id1234567890",
      "createdAt": 1730998522307,
      "clicksLimit": 100,
      "splitURL": "https://example.com/split",
      "splitPercent": 50,
      "shortURL": "https://short.gy/abc123",
      "secureShortURL": "https://short.gy/abc123",
      "FolderId": "abc123",
      "DomainId": 1,
      "OwnerId": 1,
      "User": {
        "id": 123,
        "name": "John Doe",
        "email": "a@example.com",
        "photoURL": "https://example.com/photo.jpg"
      }
    }
  ]
}