> ## Documentation Index
> Fetch the complete documentation index at: https://docs.modulex.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Short.io Integration for AI Agents & Workflows

> URL shortening and link management platform with advanced analytics, custom domains, and device targeting.

{/* Self-hosted logo — build-time vendored from modulex.json / Iconify (see scripts/lib/logo.js). */}

<img className="block dark:hidden" src="https://mintcdn.com/modulexaillc/df8MOr-hXotYLTh5/logos/short-io-light.svg?fit=max&auto=format&n=df8MOr-hXotYLTh5&q=85&s=642dee82a7729a05adad786ca77cea1b" alt="Short.io logo" width="72" height="72" data-path="logos/short-io-light.svg" />

<img className="hidden dark:block" src="https://mintcdn.com/modulexaillc/df8MOr-hXotYLTh5/logos/short-io-dark.svg?fit=max&auto=format&n=df8MOr-hXotYLTh5&q=85&s=b0e545ed010f4381d6afc630df848a3e" alt="Short.io logo" width="72" height="72" data-path="logos/short-io-dark.svg" />

## Overview

Add **Short.io** to any ModuleX agent or workflow. URL shortening, link management, and analytics against the Short.io REST API (`api.short.io` for CRUD, `api-v2.short.cm` for statistics).

<Info>
  **Categories**: Marketing & Advertising · Utilities · Link Management · Analytics · **Auth**: API Key · **Actions**: 8
</Info>

## Authentication

### API Key Authentication

Authenticate using your Short.io Secret API Key

<Steps>
  <Step title="Step 1">
    Log in to your Short.io account
  </Step>

  <Step title="Step 2">
    Go to Settings & Integrations
  </Step>

  <Step title="Step 3">
    Click on 'Integrations & API'
  </Step>

  <Step title="Step 4">
    Copy your Secret API Key
  </Step>
</Steps>

#### Required Credentials

| Field                   | Description                                     | Required | Format                                |
| ----------------------- | ----------------------------------------------- | -------- | ------------------------------------- |
| Short.io Secret API Key | Your Short.io Secret API Key for authentication | Yes      | `sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` |

## Available Actions

<AccordionGroup>
  <Accordion title="create_link — Create a new short link with optional customization including custom paths, device-specific redirects, UTM parameters, and expiration">
    ### Parameters

    <ResponseField name="domain" type="string" required>
      Domain name for the short link
    </ResponseField>

    <ResponseField name="original_url" type="string" required>
      The original URL to shorten
    </ResponseField>

    <ResponseField name="path" type="string">
      Custom path for the short link (auto-generated if empty)
    </ResponseField>

    <ResponseField name="title" type="string">
      Title for the link shown in admin panel
    </ResponseField>

    <ResponseField name="tags" type="array">
      Tags for organizing links
    </ResponseField>

    <ResponseField name="allow_duplicates" type="boolean">
      Allow duplicate links for same URL
    </ResponseField>

    <ResponseField name="expires_at" type="string">
      Expiration date in yyyy-mm-dd format
    </ResponseField>

    <ResponseField name="expired_url" type="string">
      URL to redirect to when link expires
    </ResponseField>

    <ResponseField name="iphone_url" type="string">
      Redirect URL for iPhone users
    </ResponseField>

    <ResponseField name="android_url" type="string">
      Redirect URL for Android users
    </ResponseField>

    <ResponseField name="password" type="string">
      Password protection (Personal plan required)
    </ResponseField>

    <ResponseField name="utm_source" type="string">
      UTM source parameter
    </ResponseField>

    <ResponseField name="utm_medium" type="string">
      UTM medium parameter
    </ResponseField>

    <ResponseField name="utm_campaign" type="string">
      UTM campaign parameter
    </ResponseField>

    <ResponseField name="utm_term" type="string">
      UTM term parameter
    </ResponseField>

    <ResponseField name="utm_content" type="string">
      UTM content parameter
    </ResponseField>

    <ResponseField name="cloaking" type="boolean">
      Enable link cloaking
    </ResponseField>

    <ResponseField name="redirect_type" type="integer">
      HTTP redirect status code (301, 302, 303, 307, 308)
    </ResponseField>

    <ResponseField name="folder_id" type="string">
      Folder ID to organize the link
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "$defs": {
        "ShortIOLink": {
          "additionalProperties": false,
          "properties": {
            "originalURL": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Originalurl"
            },
            "path": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Path"
            },
            "idString": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Idstring"
            },
            "id": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Id"
            },
            "shortURL": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Shorturl"
            },
            "secureShortURL": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Secureshorturl"
            },
            "cloaking": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Cloaking"
            },
            "title": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Title"
            },
            "tags": {
              "items": {
                "type": "string"
              },
              "title": "Tags",
              "type": "array"
            },
            "createdAt": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Createdat"
            },
            "DomainId": {
              "anyOf": [
                {
                  "type": "integer"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Domainid"
            },
            "OwnerId": {
              "anyOf": [
                {
                  "type": "integer"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Ownerid"
            },
            "skipQS": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Skipqs"
            },
            "archived": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Archived"
            },
            "hasPassword": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Haspassword"
            },
            "source": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Source"
            },
            "expiresAt": {
              "default": null,
              "title": "Expiresat"
            },
            "expiredURL": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Expiredurl"
            },
            "User": {
              "anyOf": [
                {
                  "additionalProperties": true,
                  "type": "object"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "User"
            }
          },
          "title": "ShortIOLink",
          "type": "object"
        }
      },
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "link": {
          "anyOf": [
            {
              "$ref": "#/$defs/ShortIOLink"
            },
            {
              "type": "null"
            }
          ],
          "default": null
        }
      },
      "required": [
        "success"
      ],
      "title": "CreateLinkOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="update_link — Update an existing short link's properties including original URL, path, title, and redirect settings">
    ### Parameters

    <ResponseField name="link_id" type="string" required>
      The ID of the link to update
    </ResponseField>

    <ResponseField name="original_url" type="string">
      New original URL
    </ResponseField>

    <ResponseField name="path" type="string">
      New custom path
    </ResponseField>

    <ResponseField name="title" type="string">
      New title
    </ResponseField>

    <ResponseField name="tags" type="array">
      New tags
    </ResponseField>

    <ResponseField name="expires_at" type="string">
      New expiration date in yyyy-mm-dd format
    </ResponseField>

    <ResponseField name="expired_url" type="string">
      New expired redirect URL
    </ResponseField>

    <ResponseField name="iphone_url" type="string">
      New iPhone redirect URL
    </ResponseField>

    <ResponseField name="android_url" type="string">
      New Android redirect URL
    </ResponseField>

    <ResponseField name="password" type="string">
      New password
    </ResponseField>

    <ResponseField name="utm_source" type="string">
      UTM source parameter
    </ResponseField>

    <ResponseField name="utm_medium" type="string">
      UTM medium parameter
    </ResponseField>

    <ResponseField name="utm_campaign" type="string">
      UTM campaign parameter
    </ResponseField>

    <ResponseField name="utm_term" type="string">
      UTM term parameter
    </ResponseField>

    <ResponseField name="utm_content" type="string">
      UTM content parameter
    </ResponseField>

    <ResponseField name="cloaking" type="boolean">
      Enable/disable cloaking
    </ResponseField>

    <ResponseField name="redirect_type" type="integer">
      New HTTP redirect status code
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "$defs": {
        "ShortIOLink": {
          "additionalProperties": false,
          "properties": {
            "originalURL": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Originalurl"
            },
            "path": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Path"
            },
            "idString": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Idstring"
            },
            "id": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Id"
            },
            "shortURL": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Shorturl"
            },
            "secureShortURL": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Secureshorturl"
            },
            "cloaking": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Cloaking"
            },
            "title": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Title"
            },
            "tags": {
              "items": {
                "type": "string"
              },
              "title": "Tags",
              "type": "array"
            },
            "createdAt": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Createdat"
            },
            "DomainId": {
              "anyOf": [
                {
                  "type": "integer"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Domainid"
            },
            "OwnerId": {
              "anyOf": [
                {
                  "type": "integer"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Ownerid"
            },
            "skipQS": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Skipqs"
            },
            "archived": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Archived"
            },
            "hasPassword": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Haspassword"
            },
            "source": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Source"
            },
            "expiresAt": {
              "default": null,
              "title": "Expiresat"
            },
            "expiredURL": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Expiredurl"
            },
            "User": {
              "anyOf": [
                {
                  "additionalProperties": true,
                  "type": "object"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "User"
            }
          },
          "title": "ShortIOLink",
          "type": "object"
        }
      },
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "link": {
          "anyOf": [
            {
              "$ref": "#/$defs/ShortIOLink"
            },
            {
              "type": "null"
            }
          ],
          "default": null
        }
      },
      "required": [
        "success"
      ],
      "title": "UpdateLinkOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="delete_link — Permanently delete a short link. This action cannot be undone">
    ### Parameters

    <ResponseField name="link_id" type="string" required>
      The ID of the link to delete
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "link_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Link Id"
        },
        "response": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Response"
        }
      },
      "required": [
        "success"
      ],
      "title": "DeleteLinkOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="expire_link — Set expiration date for a short link and configure the redirect URL after expiration">
    ### Parameters

    <ResponseField name="link_id" type="string" required>
      The ID of the link to expire
    </ResponseField>

    <ResponseField name="expires_at" type="string" required>
      Expiration date in yyyy-mm-dd format
    </ResponseField>

    <ResponseField name="expired_url" type="string" required>
      URL to redirect to when link expires
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "$defs": {
        "ShortIOLink": {
          "additionalProperties": false,
          "properties": {
            "originalURL": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Originalurl"
            },
            "path": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Path"
            },
            "idString": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Idstring"
            },
            "id": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Id"
            },
            "shortURL": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Shorturl"
            },
            "secureShortURL": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Secureshorturl"
            },
            "cloaking": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Cloaking"
            },
            "title": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Title"
            },
            "tags": {
              "items": {
                "type": "string"
              },
              "title": "Tags",
              "type": "array"
            },
            "createdAt": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Createdat"
            },
            "DomainId": {
              "anyOf": [
                {
                  "type": "integer"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Domainid"
            },
            "OwnerId": {
              "anyOf": [
                {
                  "type": "integer"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Ownerid"
            },
            "skipQS": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Skipqs"
            },
            "archived": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Archived"
            },
            "hasPassword": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Haspassword"
            },
            "source": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Source"
            },
            "expiresAt": {
              "default": null,
              "title": "Expiresat"
            },
            "expiredURL": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Expiredurl"
            },
            "User": {
              "anyOf": [
                {
                  "additionalProperties": true,
                  "type": "object"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "User"
            }
          },
          "title": "ShortIOLink",
          "type": "object"
        }
      },
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "link": {
          "anyOf": [
            {
              "$ref": "#/$defs/ShortIOLink"
            },
            {
              "type": "null"
            }
          ],
          "default": null
        }
      },
      "required": [
        "success"
      ],
      "title": "ExpireLinkOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="get_link_info — Retrieve detailed information about a specific short link by domain and path">
    ### Parameters

    <ResponseField name="domain" type="string" required>
      Domain of the short link
    </ResponseField>

    <ResponseField name="path" type="string" required>
      Path of the short link (without leading slash)
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "$defs": {
        "ShortIOLink": {
          "additionalProperties": false,
          "properties": {
            "originalURL": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Originalurl"
            },
            "path": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Path"
            },
            "idString": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Idstring"
            },
            "id": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Id"
            },
            "shortURL": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Shorturl"
            },
            "secureShortURL": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Secureshorturl"
            },
            "cloaking": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Cloaking"
            },
            "title": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Title"
            },
            "tags": {
              "items": {
                "type": "string"
              },
              "title": "Tags",
              "type": "array"
            },
            "createdAt": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Createdat"
            },
            "DomainId": {
              "anyOf": [
                {
                  "type": "integer"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Domainid"
            },
            "OwnerId": {
              "anyOf": [
                {
                  "type": "integer"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Ownerid"
            },
            "skipQS": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Skipqs"
            },
            "archived": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Archived"
            },
            "hasPassword": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Haspassword"
            },
            "source": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Source"
            },
            "expiresAt": {
              "default": null,
              "title": "Expiresat"
            },
            "expiredURL": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Expiredurl"
            },
            "User": {
              "anyOf": [
                {
                  "additionalProperties": true,
                  "type": "object"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "User"
            }
          },
          "title": "ShortIOLink",
          "type": "object"
        }
      },
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "link": {
          "anyOf": [
            {
              "$ref": "#/$defs/ShortIOLink"
            },
            {
              "type": "null"
            }
          ],
          "default": null
        }
      },
      "required": [
        "success"
      ],
      "title": "GetLinkInfoOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="list_links — List all short links associated with a specific domain">
    ### Parameters

    <ResponseField name="domain_id" type="integer" required>
      Domain ID to list links for
    </ResponseField>

    <ResponseField name="limit" type="integer">
      Maximum number of links to return (max 150) (Default: `150`)
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "$defs": {
        "ShortIOLink": {
          "additionalProperties": false,
          "properties": {
            "originalURL": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Originalurl"
            },
            "path": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Path"
            },
            "idString": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Idstring"
            },
            "id": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Id"
            },
            "shortURL": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Shorturl"
            },
            "secureShortURL": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Secureshorturl"
            },
            "cloaking": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Cloaking"
            },
            "title": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Title"
            },
            "tags": {
              "items": {
                "type": "string"
              },
              "title": "Tags",
              "type": "array"
            },
            "createdAt": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Createdat"
            },
            "DomainId": {
              "anyOf": [
                {
                  "type": "integer"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Domainid"
            },
            "OwnerId": {
              "anyOf": [
                {
                  "type": "integer"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Ownerid"
            },
            "skipQS": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Skipqs"
            },
            "archived": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Archived"
            },
            "hasPassword": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Haspassword"
            },
            "source": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Source"
            },
            "expiresAt": {
              "default": null,
              "title": "Expiresat"
            },
            "expiredURL": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Expiredurl"
            },
            "User": {
              "anyOf": [
                {
                  "additionalProperties": true,
                  "type": "object"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "User"
            }
          },
          "title": "ShortIOLink",
          "type": "object"
        }
      },
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "links": {
          "items": {
            "$ref": "#/$defs/ShortIOLink"
          },
          "title": "Links",
          "type": "array"
        },
        "count": {
          "default": 0,
          "title": "Count",
          "type": "integer"
        }
      },
      "required": [
        "success"
      ],
      "title": "ListLinksOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="list_domains — List all domains configured in your Short.io account">
    ### Response

    ```json theme={null}
    {
      "$defs": {
        "ShortIODomain": {
          "additionalProperties": false,
          "properties": {
            "id": {
              "anyOf": [
                {
                  "type": "integer"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Id"
            },
            "hostname": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Hostname"
            },
            "protocol": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Protocol"
            },
            "created": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Created"
            }
          },
          "title": "ShortIODomain",
          "type": "object"
        }
      },
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "domains": {
          "items": {
            "$ref": "#/$defs/ShortIODomain"
          },
          "title": "Domains",
          "type": "array"
        },
        "count": {
          "default": 0,
          "title": "Count",
          "type": "integer"
        }
      },
      "required": [
        "success"
      ],
      "title": "ListDomainsOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="get_domain_statistics — Retrieve detailed click statistics and analytics for a specific domain">
    ### Parameters

    <ResponseField name="domain_id" type="integer" required>
      Domain ID to get statistics for
    </ResponseField>

    <ResponseField name="period" type="string">
      Time period: total, custom, today, yesterday, week, month, lastmonth, last7, last30 (Default: `last30`)
    </ResponseField>

    <ResponseField name="clicks_chart_interval" type="string">
      Chart interval: hour, day, week, month
    </ResponseField>

    <ResponseField name="tz_offset" type="integer">
      Timezone offset in minutes
    </ResponseField>

    <ResponseField name="start_date" type="string">
      Start date for custom period (yyyy-mm-dd)
    </ResponseField>

    <ResponseField name="end_date" type="string">
      End date for custom period (yyyy-mm-dd)
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "statistics": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Statistics"
        }
      },
      "required": [
        "success"
      ],
      "title": "GetDomainStatisticsOutput",
      "type": "object"
    }
    ```
  </Accordion>
</AccordionGroup>

## Limits & Quotas

* `list_links` is capped at 150 entries per call (Short.io's max).
* Date strings (`expires_at`) are parsed from `yyyy-mm-dd` and sent
  as Unix-millisecond timestamps; invalid dates silently drop the
  field rather than fail the call (preserves legacy behavior).
* `get_domain_statistics` calls the separate
  `api-v2.short.cm` analytics host; everything else hits `api.short.io`.
* Failure paths surface as `success=False` + `error` (HTTP non-2xx,
  exceptions, empty API keys).

## Related integrations

<CardGroup cols={3}>
  <Card title="SEMrush" href="/integrations/tools/semrush" />

  <Card title="TinyURL" href="/integrations/tools/tinyurl" />

  <Card title="Ahrefs" href="/integrations/tools/ahrefs" />
</CardGroup>

## Links

* [Short.io](https://short.io)