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).
Categories: Marketing & Advertising · Utilities · Link Management · Analytics · Auth: API Key · Actions: 8
Authentication
API Key Authentication
Authenticate using your Short.io Secret API Key1
Step 1
Log in to your Short.io account
2
Step 2
Go to Settings & Integrations
3
Step 3
Click on ‘Integrations & API’
4
Step 4
Copy your Secret API Key
Required Credentials
| Field | Description | Required | Format |
|---|---|---|---|
| Short.io Secret API Key | Your Short.io Secret API Key for authentication | Yes | sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
Available Actions
create_link — Create a new short link with optional customization including custom paths, device-specific redirects, UTM parameters, and expiration
create_link — Create a new short link with optional customization including custom paths, device-specific redirects, UTM parameters, and expiration
Parameters
string
required
Domain name for the short link
string
required
The original URL to shorten
string
Custom path for the short link (auto-generated if empty)
string
Title for the link shown in admin panel
array
Tags for organizing links
boolean
Allow duplicate links for same URL
string
Expiration date in yyyy-mm-dd format
string
URL to redirect to when link expires
string
Redirect URL for iPhone users
string
Redirect URL for Android users
string
Password protection (Personal plan required)
string
UTM source parameter
string
UTM medium parameter
string
UTM campaign parameter
string
UTM term parameter
string
UTM content parameter
boolean
Enable link cloaking
integer
HTTP redirect status code (301, 302, 303, 307, 308)
string
Folder ID to organize the link
Response
{
"$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"
}
update_link — Update an existing short link's properties including original URL, path, title, and redirect settings
update_link — Update an existing short link's properties including original URL, path, title, and redirect settings
Parameters
string
required
The ID of the link to update
string
New original URL
string
New custom path
string
New title
array
New tags
string
New expiration date in yyyy-mm-dd format
string
New expired redirect URL
string
New iPhone redirect URL
string
New Android redirect URL
string
New password
string
UTM source parameter
string
UTM medium parameter
string
UTM campaign parameter
string
UTM term parameter
string
UTM content parameter
boolean
Enable/disable cloaking
integer
New HTTP redirect status code
Response
{
"$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"
}
delete_link — Permanently delete a short link. This action cannot be undone
delete_link — Permanently delete a short link. This action cannot be undone
Parameters
string
required
The ID of the link to delete
Response
{
"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"
}
expire_link — Set expiration date for a short link and configure the redirect URL after expiration
expire_link — Set expiration date for a short link and configure the redirect URL after expiration
Parameters
string
required
The ID of the link to expire
string
required
Expiration date in yyyy-mm-dd format
string
required
URL to redirect to when link expires
Response
{
"$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"
}
get_link_info — Retrieve detailed information about a specific short link by domain and path
get_link_info — Retrieve detailed information about a specific short link by domain and path
Parameters
string
required
Domain of the short link
string
required
Path of the short link (without leading slash)
Response
{
"$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"
}
list_links — List all short links associated with a specific domain
list_links — List all short links associated with a specific domain
Parameters
integer
required
Domain ID to list links for
integer
Maximum number of links to return (max 150) (Default:
150)Response
{
"$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"
}
list_domains — List all domains configured in your Short.io account
list_domains — List all domains configured in your Short.io account
Response
{
"$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"
}
get_domain_statistics — Retrieve detailed click statistics and analytics for a specific domain
get_domain_statistics — Retrieve detailed click statistics and analytics for a specific domain
Parameters
integer
required
Domain ID to get statistics for
string
Time period: total, custom, today, yesterday, week, month, lastmonth, last7, last30 (Default:
last30)string
Chart interval: hour, day, week, month
integer
Timezone offset in minutes
string
Start date for custom period (yyyy-mm-dd)
string
End date for custom period (yyyy-mm-dd)
Response
{
"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"
}
Limits & Quotas
list_linksis capped at 150 entries per call (Short.io’s max).- Date strings (
expires_at) are parsed fromyyyy-mm-ddand sent as Unix-millisecond timestamps; invalid dates silently drop the field rather than fail the call (preserves legacy behavior). get_domain_statisticscalls the separateapi-v2.short.cmanalytics host; everything else hitsapi.short.io.- Failure paths surface as
success=False+error(HTTP non-2xx, exceptions, empty API keys).