---
updatedAt: 2025-11-05T21:12:25.000Z
agentTools:
  projectIndex: https://developers.short.io/llms.txt
---

# Link list

Get domain links

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Short.io API",
    "version": "1.0.0"
  },
  "components": {
    "securitySchemes": {
      "apiKey": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    }
  },
  "paths": {
    "/api/links": {
      "get": {
        "summary": "Link list",
        "tags": [
          "Link queries"
        ],
        "description": "Get domain links",
        "parameters": [
          {
            "schema": {
              "minimum": 1,
              "type": "integer"
            },
            "example": 12345,
            "in": "query",
            "name": "domain_id",
            "required": true,
            "description": "Domain ID"
          },
          {
            "schema": {
              "minimum": 1,
              "maximum": 150,
              "nullable": true,
              "type": "integer"
            },
            "in": "query",
            "name": "limit",
            "required": false
          },
          {
            "schema": {
              "type": "string"
            },
            "in": "query",
            "name": "idString",
            "required": false
          },
          {
            "schema": {
              "type": "string"
            },
            "in": "query",
            "name": "createdAt",
            "required": false
          },
          {
            "schema": {
              "format": "date-time",
              "type": "string"
            },
            "in": "query",
            "name": "beforeDate",
            "required": false
          },
          {
            "schema": {
              "format": "date-time",
              "type": "string"
            },
            "in": "query",
            "name": "afterDate",
            "required": false
          },
          {
            "schema": {
              "enum": [
                "asc",
                "desc"
              ],
              "type": "string"
            },
            "in": "query",
            "name": "dateSortOrder",
            "required": false
          },
          {
            "schema": {
              "type": "string"
            },
            "in": "query",
            "name": "pageToken",
            "required": false
          },
          {
            "schema": {
              "type": "string"
            },
            "in": "query",
            "name": "folderId",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "Default Response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "count": {
                      "type": "integer"
                    },
                    "links": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "originalURL": {
                            "description": "Original URL",
                            "type": "string",
                            "example": "https://example.com"
                          },
                          "cloaking": {
                            "description": "Cloaking",
                            "type": "boolean"
                          },
                          "password": {
                            "description": "Link password",
                            "type": "string",
                            "example": "s3cur3p@ssw0rd"
                          },
                          "expiresAt": {
                            "description": "Link expiration date in milliseconds or ISO string",
                            "anyOf": [
                              {
                                "nullable": true,
                                "type": "integer"
                              },
                              {
                                "format": "iso-date-time",
                                "nullable": true,
                                "type": "string"
                              }
                            ],
                            "example": "2024-11-07T16:55:22.307Z"
                          },
                          "expiredURL": {
                            "nullable": true,
                            "description": "Expired URL",
                            "type": "string",
                            "example": "https://example.com/expired"
                          },
                          "title": {
                            "description": "Link title",
                            "type": "string"
                          },
                          "tags": {
                            "description": "Array of link tags",
                            "type": "array",
                            "items": {
                              "type": "string"
                            }
                          },
                          "utmSource": {
                            "description": "set utm_source parameter to destination link",
                            "type": "string",
                            "example": "cpc"
                          },
                          "utmMedium": {
                            "description": "set utm_medium parameter to destination link",
                            "type": "string",
                            "example": "banner"
                          },
                          "utmCampaign": {
                            "description": "set utm_campaign parameter to destination link",
                            "type": "string",
                            "example": "summer_sale"
                          },
                          "utmTerm": {
                            "description": "set utm_term parameter to destination link",
                            "type": "string",
                            "example": "running_shoes"
                          },
                          "utmContent": {
                            "description": "set utm_content parameter to destination link",
                            "type": "string",
                            "example": "cta_button"
                          },
                          "ttl": {
                            "description": "Time to live in milliseconds or ISO string",
                            "anyOf": [
                              {
                                "format": "iso-date-time",
                                "nullable": true,
                                "type": "string"
                              },
                              {
                                "nullable": true,
                                "type": "integer"
                              }
                            ],
                            "example": "2024-11-07T16:55:22.307Z"
                          },
                          "path": {
                            "allOf": [
                              {
                                "nullable": true,
                                "description": "Link slug",
                                "examples": [
                                  "my-link"
                                ],
                                "type": "string"
                              },
                              {
                                "nullable": true,
                                "description": "Link slug",
                                "examples": [
                                  "my-link"
                                ],
                                "type": "string"
                              }
                            ]
                          },
                          "androidURL": {
                            "description": "Android URL",
                            "nullable": true,
                            "type": "string",
                            "example": "https://play.google.com/store/apps/details?id=com.example.app"
                          },
                          "iphoneURL": {
                            "description": "iPhone URL",
                            "nullable": true,
                            "type": "string",
                            "example": "https://apps.apple.com/us/app/example-app/id1234567890"
                          },
                          "createdAt": {
                            "description": "Link creation date in milliseconds",
                            "anyOf": [
                              {
                                "nullable": true,
                                "examples": [
                                  1730998522307
                                ],
                                "type": "integer"
                              },
                              {
                                "format": "iso-date-time",
                                "nullable": true,
                                "type": "string"
                              }
                            ],
                            "example": "2024-11-07T16:55:22.307Z"
                          },
                          "clicksLimit": {
                            "nullable": true,
                            "minimum": 1,
                            "description": "disable link after specified number of clicks",
                            "type": "integer",
                            "example": 100
                          },
                          "passwordContact": {
                            "description": "Provide your email to users to get a password",
                            "nullable": true,
                            "type": "boolean"
                          },
                          "skipQS": {
                            "description": "Skip query string merging",
                            "default": false,
                            "type": "boolean"
                          },
                          "archived": {
                            "description": "Link is archived",
                            "default": false,
                            "type": "boolean"
                          },
                          "splitURL": {
                            "description": "Split URL",
                            "nullable": true,
                            "type": "string",
                            "example": "https://example.com/split"
                          },
                          "splitPercent": {
                            "nullable": true,
                            "minimum": 1,
                            "maximum": 100,
                            "description": "Split URL percentage",
                            "type": "integer",
                            "example": 50
                          },
                          "integrationAdroll": {
                            "description": "Adroll integration",
                            "nullable": true,
                            "type": "string"
                          },
                          "integrationFB": {
                            "description": "Facebook integration",
                            "nullable": true,
                            "type": "string"
                          },
                          "integrationGA": {
                            "description": "Google Analytics integration",
                            "nullable": true,
                            "type": "string"
                          },
                          "integrationGTM": {
                            "description": "Google Tag Manager integration",
                            "nullable": true,
                            "type": "string"
                          },
                          "idString": {
                            "description": "Link ID",
                            "type": "string"
                          },
                          "id": {
                            "description": "Link ID",
                            "type": "string"
                          },
                          "shortURL": {
                            "description": "Short URL",
                            "type": "string",
                            "example": "https://short.gy/abc123"
                          },
                          "secureShortURL": {
                            "description": "Secure short URL",
                            "type": "string",
                            "example": "https://short.gy/abc123"
                          },
                          "redirectType": {
                            "description": "HTTP code for redirect",
                            "enum": [
                              "301",
                              "302",
                              "307",
                              "308"
                            ],
                            "type": "string"
                          },
                          "FolderId": {
                            "description": "Folder ID",
                            "nullable": true,
                            "type": "string",
                            "example": "abc123"
                          },
                          "DomainId": {
                            "description": "Domain ID",
                            "type": "integer",
                            "example": 1
                          },
                          "OwnerId": {
                            "description": "Owner ID",
                            "type": "integer",
                            "example": 1
                          },
                          "hasPassword": {
                            "description": "Link has password",
                            "default": false,
                            "type": "boolean"
                          },
                          "User": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "description": "Creator user ID",
                                "type": "integer",
                                "example": 123
                              },
                              "name": {
                                "description": "Creator name",
                                "nullable": true,
                                "type": "string",
                                "example": "John Doe"
                              },
                              "email": {
                                "description": "Creator email",
                                "type": "string",
                                "example": "a@example.com"
                              },
                              "photoURL": {
                                "description": "User photo URL",
                                "nullable": true,
                                "type": "string",
                                "example": "https://example.com/photo.jpg"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "email",
                              "photoURL"
                            ]
                          }
                        },
                        "required": [
                          "originalURL",
                          "path",
                          "idString",
                          "id",
                          "shortURL",
                          "secureShortURL"
                        ]
                      }
                    },
                    "nextPageToken": {
                      "nullable": true,
                      "type": "string"
                    }
                  },
                  "required": [
                    "count",
                    "links"
                  ]
                }
              }
            }
          },
          "403": {
            "description": "Default Response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "error"
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.short.io",
      "description": "API server"
    }
  ],
  "security": [
    {
      "apiKey": []
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```