Link queries

Link list

Get domain links

get/api/links

Request

  • Base URL: https://api.short.io
  • URL: https://api.short.io/api/links
  • Auth: API key in header Authorization

Query parameters

domain_idinteger required

Domain ID

limitinteger nullable

Maximum number of links to return

idStringstring

Link ID string for pagination cursor

createdAtstring

Pagination cursor by link creation date

beforeDatestring date-time

Return links created before this date

afterDatestring date-time

Return links created after this date

dateSortOrder'asc' | 'desc'

Sort order by creation date

pageTokenstring

Opaque cursor for paginating link results

folderIdstring

Restrict results to a specific folder

Response

Default Response

countinteger required

Total number of matching links

nextPageTokenstring nullable required

Cursor for the next page, or null if no more results

Example response

{
  "count": 42,
  "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",
      "androidURL": "https://play.google.com/store/apps/details?id=com.example.app",
      "iphoneURL": "https://apps.apple.com/us/app/example-app/id1234567890",
      "clicksLimit": 100,
      "splitURL": "https://example.com/split",
      "splitPercent": 50,
      "shortURL": "https://short.gy/abc123",
      "secureShortURL": "https://short.gy/abc123",
      "path": "my-link",
      "displayPath": "My-Link",
      "FolderId": "abc123",
      "DomainId": 1,
      "OwnerId": 1,
      "source": "api",
      "pageType": 2,
      "User": {
        "id": 123,
        "name": "John Doe",
        "email": "a@example.com",
        "photoURL": "https://example.com/photo.jpg"
      }
    }
  ],
  "nextPageToken": "page_1a2b3c_lnk_4d5e6f"
}

Changes

No recorded changes to this operation across all 1 revision of this API.