---
title: "Link list"
method: GET
path: "/api/links"
tags: ["Link queries"]
---

# Link list

`GET /api/links`

## Request

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

Get domain links

## Query parameters

- `domain_id` integer, required
- `limit` integer, nullable
- `idString` string
- `createdAt` string
- `beforeDate` string, date-time
- `afterDate` string, date-time
- `dateSortOrder` 'asc' | 'desc'
- `pageToken` string
- `folderId` string

## Response `200`

Default Response

- object
  - `count` integer, required: Total number of matching links
  - `links` object[], required: List of links
    - `originalURL` string, required: Original URL
    - `cloaking` boolean: Cloaking
    - `password` string: Link password
    - `expiresAt` union: Link expiration date in milliseconds or ISO string
      - integer, nullable
      - string, iso-date-time, nullable
    - `expiredURL` string, nullable: Expired URL
    - `title` string: Link title
    - `tags` string[]: Array of link tags
    - `utmSource` string: set utm_source parameter to destination link
    - `utmMedium` string: set utm_medium parameter to destination link
    - `utmCampaign` string: set utm_campaign parameter to destination link
    - `utmTerm` string: set utm_term parameter to destination link
    - `utmContent` string: set utm_content parameter to destination link
    - `ttl` union: Time to live in milliseconds or ISO string
      - string, iso-date-time, nullable
      - integer, nullable
    - `androidURL` string, nullable: Android URL
    - `iphoneURL` string, nullable: iPhone URL
    - `clicksLimit` integer, nullable: disable link after specified number of clicks
    - `passwordContact` boolean, nullable: Provide your email to users to get a password
    - `skipQS` boolean: Skip query string merging
    - `archived` boolean: Link is archived
    - `splitURL` string, nullable: Split URL
    - `splitPercent` integer, nullable: Split URL percentage
    - `splitURLV2` object[], nullable: Split URL configurations for multi-way A/B testing
      - `url` string, required: Split URL destination
      - `percent` integer, required: Traffic percentage
    - `integrationAdroll` string, nullable: Adroll integration
    - `integrationFB` string, nullable: Facebook integration
    - `integrationTT` string, nullable: TikTok integration
    - `integrationGA` string, nullable: Google Analytics integration
    - `integrationGTM` string, nullable: Google Tag Manager integration
    - `idString` string, required: Link ID
    - `id` string, required: Link ID
    - `shortURL` string, required: Short URL
    - `secureShortURL` string, required: Secure short URL
    - `path` string, nullable, required: Link slug. For case-insensitive domains, this is the normalized lowercase version of the path.
    - `displayPath` string, nullable, required: Original path preserving the case as provided during creation. Set only for case-insensitive domains when the path contains uppercase characters, otherwise null.
    - `redirectType` '301' | '302' | '307' | '308': HTTP code for redirect
    - `createdAt` string, iso-date-time, nullable, required: Link creation date in ISO format
    - `updatedAt` string, iso-date-time, nullable, required: Link last update date in ISO format
    - `FolderId` string, nullable: Folder ID
    - `DomainId` integer: Domain ID
    - `OwnerId` integer: Owner ID
    - `hasPassword` boolean: Link has password
    - `source` 'website' | 'api' | 'public' | 'spreadsheets' | 'slack' | 'telegram' | '': Link source
    - `pageType` 1 | 2: Special page type rendered at the short link: 1 = bundle, 2 = post. Absent for normal redirect links.
    - `User` object, nullable
      - `id` integer, required: Creator user ID
      - `name` string, nullable, required: Creator name
      - `email` string, required: Creator email
      - `photoURL` string, nullable, required: User photo URL
  - `nextPageToken` string, nullable, required: Cursor for the next page, or null if no more results

## Other responses

- `402`: Default Response
- `403`: Default Response
- `404`: Default Response

---

[API](https://skmtc.dev/short/apis/short-io-api-2.md) · [All operations](https://skmtc.dev/short/apis/short-io-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/short/apis/short-io-api-2/revisions/9e4e60c560b1?raw)