The Short.io connector lets your AI agent act in each user's Short.io account. Each user connects their own Short.io API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 41 tools.
- Tools
- 41
- What they doRead · write · destructive
- 19 · 16 · 619 read16 write6 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Short.io connection
In AgentKit > Connections, create a Short.io connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'shortio'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Short.io:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'shortio_bundle_templates_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "shortio"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Short.io:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="shortio_bundle_templates_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Short.io credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolshortio_audit_log_listList audit log entries for a domain, optionally by user, action type or link.Read-onlyList Audit Log
List audit log entries for a domain, optionally by user, action type or link. Returns records, nextPageToken. Get the domain ID from shortio_domains_list.
Inputs
domain_idnumberrequired- Domain to fetch audit records for. Example: 123456
action_typestring- Filter records by operation type, e.g. "create", "update", "delete". Example: update
limitinteger- Maximum number of records to return. Example: 50
link_idstring- Filter records by link id, matched exactly as stored. Example: lnk_4Lx2_aBcD3fGh1
page_tokenstring- Pagination cursor from previous response. Example: example
team_idinteger- Team scope; current user must be owner. Example: 321
user_idinteger- Filter records by team member user id. Example: 98765
shortio_bundle_getGet one link bundle with its settings.Read-onlyGet Bundle
Get one link bundle with its settings. Use shortio_bundle_links_list for its links.
Inputs
idstringrequired- Bundle ULID id. Example: 01HZX5K9ABCDEF1234567890
shortio_bundle_links_listList the links on a bundle page.Read-onlyList Bundle Links
List the links on a bundle page. Use shortio_bundle_link_add to add one.
Inputs
idstringrequired- Bundle ULID id. Example: 01HZX5K9ABCDEF1234567890
shortio_bundle_templates_listList the templates available for link bundles (link-in-bio pages).Read-onlyList Bundle Templates
List the templates available for link bundles (link-in-bio pages). Use this to get a TemplateId for shortio_bundle_create.
Inputs
This tool takes no inputs.
shortio_country_regions_listList the region codes available for a country.Read-onlyList Country Regions
List the region codes available for a country. Use this to get region codes for shortio_link_region_create.
Inputs
countrystringrequired- Country code. Example: USone of
ADAEAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZWEUQFQSQEQOQNQTXK
shortio_domain_getGet one domain's details and settings.Read-onlyGet Domain
Get one domain's details and settings. Returns id, hostname, unicodeHostname, state, createdAt, updatedAt, TeamId, OrganizationId, hasFavicon, faviconURL. Get the domain ID from shortio_domains_list.
Inputs
domain_idintegerrequired- Domain ID. Example: 123456
shortio_domains_listList the branded short domains in the account with IDs, hostnames and settings.Read-onlyList Domains
List the branded short domains in the account with IDs, hostnames and settings. Returns a list of records with id, hostname, unicodeHostname, state, createdAt, updatedAt, TeamId, OrganizationId, hasFavicon, faviconURL. Use this first to get the domain ID and hostname other tools need.
Inputs
limitinteger- Maximum number of domains to return. Example: 50
no_team_idboolean- Return only personal domains not assigned to a team. Example: true
offsetinteger- Number of domains to skip for pagination. Example: 0
patternstring- Hostname substring filter. Example: example
team_idnumber- Filter domains by team ID. Example: 321
shortio_folder_getGet one link folder with its default settings.Read-onlyGet Folder
Get one link folder with its default settings. Get the folder ID from shortio_folders_list.
Inputs
domain_idintegerrequired- Domain ID the folder belongs to. Example: 123456
folder_idstringrequired- Folder ID. Example: fld_01HZX5K9
shortio_folders_listList link folders on a domain.Read-onlyList Folders
List link folders on a domain. Use this to get a folder ID for link tools. Get the domain ID from shortio_domains_list.
Inputs
domain_idintegerrequired- Domain ID to list folders for. Example: 123456
shortio_link_countries_listList a link's country-specific destination URLs.Read-onlyList Link Country Targets
List a link's country-specific destination URLs. Get the link ID (lnk_...) from shortio_links_list or shortio_link_expand.
Inputs
link_idstringrequired- Numeric link ID or encoded link ID string. Example: lnk_4Lx2_aBcD3fGh1
domain_idstring- Domain ID, required only when using a legacy numeric link ID. Example: 123456
shortio_link_expandLook up a short link by domain hostname and path.Read-onlyExpand Link
Look up a short link by domain hostname and path. Returns originalURL, cloaking, password, expiresAt, expiredURL, title, tags, utmSource, utmMedium, utmCampaign. Use this when you have the short URL, not the ID.
Inputs
domainstringrequired- Domain hostname. Example: go.example.com
pathstringrequired- Link path. Example: spring-sale
shortio_link_getGet one short link by ID with its destination, short URL, path, title, tags and settings.Read-onlyGet Link
Get one short link by ID with its destination, short URL, path, title, tags and settings. Returns originalURL, cloaking, password, expiresAt, expiredURL, title, tags, utmSource, utmMedium, utmCampaign. Get the link ID (lnk_...) from shortio_links_list or shortio_link_expand.
Inputs
link_idstringrequired- Numeric link ID or encoded link ID string. Example: lnk_4Lx2_aBcD3fGh1
domain_idstring- [DEPRECATED] Domain ID. Example: 123456
shortio_link_opengraph_getGet the OpenGraph (social preview) properties set on a link.Read-onlyGet Link OpenGraph
Get the OpenGraph (social preview) properties set on a link. Get the link ID (lnk_...) from shortio_links_list or shortio_link_expand.
Inputs
domain_idnumberrequired- Domain ID the link belongs to. Example: 123456
link_idstringrequired- Numeric link ID or encoded link ID string. Example: lnk_4Lx2_aBcD3fGh1
shortio_link_permissions_listList team members who were granted access to a link.Read-onlyList Link Permissions
List team members who were granted access to a link. Returns a list of records with id, DomainId, UserId, LinkIdString. Get the link ID (lnk_...) from shortio_links_list or shortio_link_expand.
Inputs
domain_idstringrequired- Domain ID the link belongs to. Example: 123456
link_idstringrequired- Numeric link ID or encoded link ID string. Example: lnk_4Lx2_aBcD3fGh1
shortio_link_regions_listList a link's region-specific destination URLs.Read-onlyList Link Region Targets
List a link's region-specific destination URLs. Get the link ID (lnk_...) from shortio_links_list or shortio_link_expand.
Inputs
link_idstringrequired- Numeric link ID or encoded link ID string. Example: lnk_4Lx2_aBcD3fGh1
domain_idstring- Domain ID, required only when using a legacy numeric link ID. Example: 123456
shortio_links_listList short links on a domain, newest first, optionally by date range or folder.Read-onlyList Links
List short links on a domain, newest first, optionally by date range or folder. Returns count, links, nextPageToken. Use this to browse links. Use shortio_link_expand to look up one link by its path. Get the domain ID from shortio_domains_list.
Inputs
domain_idintegerrequired- Domain ID. Example: 123456
after_datestring- Return links created after this date. Example: 2026-01-01T00:00:00Z
before_datestring- Return links created before this date. Example: 2026-01-31T00:00:00Z
created_atstring- Pagination cursor by link creation date. Example: example
date_sort_orderstring- Sort order by creation date. One of: asc, desc. Example: ascone of
ascdesc folder_idstring- Restrict results to a specific folder. Example: fld_01HZX5K9
id_stringstring- Link ID string for pagination cursor. Example: example
limitinteger- Maximum number of links to return. Example: 50
page_tokenstring- Opaque cursor for paginating link results. Example: example
shortio_organization_plan_getGet the organization's plan tier, billing period and usage counters (domains, links, paid links, AI spend).Read-onlyGet Organization Plan
Get the organization's plan tier, billing period and usage counters (domains, links, paid links, AI spend). Use this to check limits before bulk operations. Get the organization ID from the OrganizationId field of shortio_domains_list.
Inputs
organization_idstringrequired- Organization ID. Example: 45678
shortio_bundle_createCreate a link bundle (link-in-bio page) on a domain from a template, with title, description, logo and social profiles.WriteCreate Bundle
Create a link bundle (link-in-bio page) on a domain from a template, with title, description, logo and social profiles. Add links with shortio_bundle_link_add.
Inputs
domain_idnumberrequired- Domain ID where the bundle will be created. Example: 123456
template_idstringrequired- Template ID from available templates. Example: minimal
background_image_urlstring- Background image URL. Example: https://example.com
bluesky_usernamestring- Bluesky username. Example: Example name
descriptionstring- Bundle description. Example: All our links in one place
emailstring- Contact email address. Example: hello@example.com
fb_usernamestring- Facebook username. Example: Example name
instagram_usernamestring- Instagram username (without @) Example: Example name
linkedin_companynamestring- LinkedIn company name (mutually exclusive with linkedinUsername) Example: Example name
linkedin_usernamestring- LinkedIn username (mutually exclusive with linkedinCompanyname) Example: Example name
logo_urlstring- Profile or logo URL. Example: https://example.com/logo.png
mastodon_usernamestring- Mastodon username. Example: Example name
telegram_urlstring- Telegram URL. Example: https://example.com
threads_usernamestring- Threads username (without @) Example: Example name
titlestring- Bundle title. Example: Spring sale
twitter_usernamestring- Twitter username (without @) Example: Example name
viber_urlstring- Viber URL (must start with viber:// or https://) Example: https://example.com
whatsapp_urlstring- WhatsApp URL (must start with whatsapp:// or https://) Example: https://example.com
shortio_bundle_link_addAdd a short link to a bundle page, creating the link if it does not exist.WriteAdd Bundle Link
Add a short link to a bundle page, creating the link if it does not exist. Use shortio_bundle_links_list to see current links.
Inputs
idstringrequired- Bundle ULID id. Example: 01HZX5K9ABCDEF1234567890
pathstringrequired- Short link path or full URL. Example: spring-sale
titlestringrequired- Display title for the link. Example: Spring sale
shortio_bundle_updateUpdate a bundle's template, title, description, images or social profiles.WriteUpdate Bundle
Update a bundle's template, title, description, images or social profiles. Get the bundle ID from shortio_bundle_create.
- Idempotent
Inputs
idstringrequired- Bundle ULID id. Example: 01HZX5K9ABCDEF1234567890
background_image_urlstring- Background image URL. Example: https://example.com
bluesky_usernamestring- Bluesky username. Example: Example name
descriptionstring- Bundle description. Example: All our links in one place
domain_idnumber- Domain ID the bundle belongs to. Example: 123456
emailstring- Contact email address. Example: hello@example.com
fb_usernamestring- Facebook username. Example: Example name
instagram_usernamestring- Instagram username (without @) Example: Example name
linkedin_companynamestring- LinkedIn company name (mutually exclusive with linkedinUsername) Example: Example name
linkedin_usernamestring- LinkedIn username (mutually exclusive with linkedinCompanyname) Example: Example name
logo_urlstring- Profile or logo URL. Example: https://example.com/logo.png
mastodon_usernamestring- Mastodon username. Example: Example name
telegram_urlstring- Telegram URL. Example: https://example.com
template_idstring- Template ID. Example: minimal
threads_usernamestring- Threads username (without @) Example: Example name
titlestring- Bundle title. Example: Spring sale
twitter_usernamestring- Twitter username (without @) Example: Example name
viber_urlstring- Viber URL (must start with viber:// or https://) Example: https://example.com
whatsapp_urlstring- WhatsApp URL (must start with whatsapp:// or https://) Example: https://example.com
shortio_domain_createAdd a branded short domain to the account.WriteCreate Domain
Add a branded short domain to the account. The domain's DNS must then point to Short.io. Returns id, hostname, unicodeHostname, state, createdAt, updatedAt, TeamId, OrganizationId, hasFavicon, faviconURL. Use shortio_domains_list to see existing domains.
Inputs
hostnamestringrequired- Domain hostname. Example: go.example.com
hide_refererboolean- Strip referer header on redirect. Example: true
link_typestring- Default link type for the domain. One of: increment, random, secure, four-char, eight-char, ten-char. Example: incrementone of
incrementrandomsecurefour-chareight-charten-char team_idinteger- Team to create the domain in. Required for non-admin organization members; optional for organization admins. Example: 321
shortio_domain_settings_updateUpdate a domain's settings, such as HTTPS level, robots policy, link type, cloaking, referer hiding, webhook URL, tracking integrations and case sensitivity.WriteUpdate Domain Settings
Update a domain's settings, such as HTTPS level, robots policy, link type, cloaking, referer hiding, webhook URL, tracking integrations and case sensitivity. Returns success. Get the domain ID from shortio_domains_list.
- Idempotent
Inputs
domain_idintegerrequired- Domain ID. Example: 123456
case_sensitiveboolean- Enable case sensitivity for short links. Example: true
cloakingboolean- Enable cloaking for all links on the domain. Example: true
dedicated_certificateboolean- Issue this domain its own SSL certificate instead of one shared with the organization's other domains. Turning it on reissues the domain's certificate. Example: true
enable_aiboolean- Enable Ai. Example: true
enable_conversion_trackingboolean- Enable Conversion Tracking. Example: true
hide_refererboolean- Hide Referer. Example: true
hide_visitor_ipboolean- Don't store visitor IPs in our database. Example: true
hsts_include_sub_domainsboolean- Add includeSubDomains to the Strict-Transport-Security header when httpsLevel is "hsts". Example: true
hsts_max_ageinteger- Strict-Transport-Security max-age in seconds when httpsLevel is "hsts", from one year (31536000) to two years (63072000). Null means one year. Example: 31536000
https_levelstring- Https Level. One of: none, redirect, hsts. Example: noneone of
noneredirecthsts integration_adrollstring- Integration Adroll. Example: example
integration_fbstring- Integration Fb. Example: example
integration_gastring- Integration Ga. Example: example
integration_gtmstring- Integration Gtm. Example: G-1234567
integration_ttstring- Integration Tt. Example: example
link_typestring- Link Type. One of: increment, random, secure, four-char, eight-char, ten-char. Example: incrementone of
incrementrandomsecurefour-chareight-charten-char prevent_scrapingstring- "all" requires every visitor to pass a proof-of-work check before the link resolves. That blocks scrapers, and also link previews, crawlers and any other client that does not run JavaScript. One of: none, all. Example: noneone of
noneall qr_scan_trackingboolean- QR Scan Tracking. Example: true
robotsstring- Robots. One of: allow, disallow, noindex. Example: allowone of
allowdisallownoindex webhook_urlstring- Webhook URL. Example: https://example.com
shortio_folder_createCreate a link folder on a domain, with optional color, slug prefix, default UTM parameters, redirect type and link lifetime.WriteCreate Folder
Create a link folder on a domain, with optional color, slug prefix, default UTM parameters, redirect type and link lifetime. Get the domain ID from shortio_domains_list.
Inputs
domain_idintegerrequired- Domain ID the folder belongs to. Example: 123456
namestringrequired- Folder display name. Example: Spring campaign
colorstring- Folder display hex color. Example: #3b82f6
expires_at_daysinteger- Default link lifetime in days. Example: 30
prefixstring- Slug prefix applied to folder links. Example: spring
redirect_typeinteger- Default HTTP redirect code for folder links. Example: 301
utm_campaignstring- Default utm_campaign for folder links. Example: spring
utm_contentstring- Default utm_content for folder links. Example: header
utm_mediumstring- Default utm_medium for folder links. Example: email
utm_sourcestring- Default utm_source for folder links. Example: newsletter
utm_termstring- Default utm_term for folder links. Example: shoes
shortio_link_archiveArchive a short link so it is hidden from the dashboard list.WriteArchive Link
Archive a short link so it is hidden from the dashboard list. Returns success, error. Use shortio_link_unarchive to restore it. Get the link ID (lnk_...) from shortio_links_list or shortio_link_expand.
- Idempotent
Inputs
link_idstringrequired- Numeric link ID or encoded link ID string. Example: lnk_4Lx2_aBcD3fGh1
domain_idstring- Domain ID, required only when using a legacy numeric link ID. Example: 123456
shortio_link_country_createSend visitors from one country to a different destination URL.WriteAdd Link Country Target
Send visitors from one country to a different destination URL. Get the link ID (lnk_...) from shortio_links_list or shortio_link_expand.
Inputs
countrystringrequired- Country code. Example: USone of
ADAEAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZWEUQFQSQEQOQNQTXK link_idstringrequired- Numeric link ID or encoded link ID string. Example: lnk_4Lx2_aBcD3fGh1
original_urlstringrequired- Destination URL for visitors from this country. Example: https://example.com/landing?ref=newsletter
domain_idstring- Domain ID, required only when using a legacy numeric link ID. Example: 123456
shortio_link_createCreate a short link on a domain for a destination URL, with optional custom path, title, tags, folder, expiry, password, redirect type, click limit, UTM parameters and mobile URLs.WriteCreate Link
Create a short link on a domain for a destination URL, with optional custom path, title, tags, folder, expiry, password, redirect type, click limit, UTM parameters and mobile URLs. Returns originalURL, cloaking, password, expiresAt, expiredURL, title, tags, utmSource, utmMedium, utmCampaign. Omit path to let the domain generate one. Use shortio_links_bulk_create for many links. Reusing an existing path with a different URL fails.
Inputs
domainstringrequired- Domain hostname. Example: go.example.com
original_urlstringrequired- Original URL. Example: https://example.com/landing?ref=newsletter
allow_duplicatesboolean- Allow duplicates. Example: false
android_urlstring- Android URL. Example: https://play.google.com/store/apps/details?id=com.example
archivedboolean- Link is archived. Example: false
clicks_limitinteger- disable link after specified number of clicks. Example: 1000
cloakingboolean- Cloaking. Example: true
expired_urlstring- Expired URL. Example: https://example.com/expired
expires_atinteger- Link expiration date in milliseconds or ISO string. Example: 1767225600000
folder_idstring- Folder ID. Example: fld_01HZX5K9
iphone_urlstring- iPhone URL. Example: https://apps.apple.com/app/id123456789
passwordstring- Link password. Example: s3cret-pass
pathstring- Link slug. For case-insensitive domains, the path is normalized to lowercase and the original value is preserved in displayPath. Example: spring-sale
redirect_typeinteger- HTTP code for redirect. One of: 301, 302, 307, 308. Example: 301one of
301302307308 tagsarray- Array of link tags. Example: ["campaign"]
titlestring- Link title. Example: Spring sale
utm_campaignstring- set utm_campaign parameter to destination link. Example: spring
utm_contentstring- set utm_content parameter to destination link. Example: header
utm_mediumstring- set utm_medium parameter to destination link. Example: email
utm_sourcestring- set utm_source parameter to destination link. Example: newsletter
utm_termstring- set utm_term parameter to destination link. Example: shoes
shortio_link_duplicateCopy a short link with all its settings and targeting rules to a new random or custom path.WriteDuplicate Link
Copy a short link with all its settings and targeting rules to a new random or custom path. Returns originalURL, cloaking, password, expiresAt, expiredURL, title, tags, utmSource, utmMedium, utmCampaign. Get the link ID (lnk_...) from shortio_links_list or shortio_link_expand.
Inputs
link_idstringrequired- Encoded link ID string of the source link. Example: lnk_4Lx2_aBcD3fGh1
pathstring- Custom path for duplicated link. Example: spring-sale
shortio_link_permission_addGrant a team member access to a link.WriteAdd Link Permission
Grant a team member access to a link. Returns id, DomainId, UserId, LinkIdString. Get the link ID (lnk_...) from shortio_links_list or shortio_link_expand.
Inputs
domain_idstringrequired- Domain ID the link belongs to. Example: 123456
link_idstringrequired- Link ID. Example: lnk_4Lx2_aBcD3fGh1
user_idstringrequired- User ID to grant access to. Example: 98765
shortio_link_region_createSend visitors from one region (ISO 3166-2) to a different destination URL.WriteAdd Link Region Target
Send visitors from one region (ISO 3166-2) to a different destination URL. Use shortio_country_regions_list for region codes. Get the link ID (lnk_...) from shortio_links_list or shortio_link_expand.
Inputs
countrystringrequired- Country code. Example: USone of
ADAEAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZWEUQFQSQEQOQNQTXK link_idstringrequired- Numeric link ID or encoded link ID string. Example: lnk_4Lx2_aBcD3fGh1
original_urlstringrequired- Destination URL for visitors from this region. Example: https://example.com/landing?ref=newsletter
regionstringrequired- ISO 3166-2 region code. Example: US-CA
domain_idinteger- Domain ID. Example: 123456
shortio_link_unarchiveRestore an archived short link.WriteUnarchive Link
Restore an archived short link. Returns success, error. Get the link ID (lnk_...) from shortio_links_list or shortio_link_expand.
- Idempotent
Inputs
link_idstringrequired- Numeric link ID or encoded link ID string. Example: lnk_4Lx2_aBcD3fGh1
domain_idstring- Domain ID, required only when using a legacy numeric link ID. Example: 123456
shortio_link_updateUpdate a short link's destination URL, path, title, tags, expiry, password, redirect type, click limit, UTM parameters or mobile URLs.WriteUpdate Link
Update a short link's destination URL, path, title, tags, expiry, password, redirect type, click limit, UTM parameters or mobile URLs. Returns originalURL, cloaking, password, expiresAt, expiredURL, title, tags, utmSource, utmMedium, utmCampaign. Send only the fields to change. Get the link ID (lnk_...) from shortio_links_list or shortio_link_expand.
- Idempotent
Inputs
link_idstringrequired- Numeric link ID or encoded link ID string. Example: lnk_4Lx2_aBcD3fGh1
android_urlstring- Android URL. Example: https://play.google.com/store/apps/details?id=com.example
archivedboolean- Link is archived. Example: true
clicks_limitinteger- disable link after specified number of clicks. Example: 1000
cloakingboolean- Cloaking. Example: true
domain_idstring- Domain ID, required only when using a legacy numeric link ID. Example: 123456
expired_urlstring- Expired URL. Example: https://example.com/expired
expires_atinteger- Link expiration date in milliseconds or ISO string. Example: 1767225600000
iphone_urlstring- iPhone URL. Example: https://apps.apple.com/app/id123456789
original_urlstring- Original URL. Example: https://example.com/landing?ref=newsletter
passwordstring- Link password. Example: s3cret-pass
pathstring- Link slug. For case-insensitive domains, the path is normalized to lowercase and the original value is preserved in displayPath. Example: spring-sale
redirect_typeinteger- HTTP code for redirect. One of: 301, 302, 307, 308. Example: 301one of
301302307308 tagsarray- Array of link tags. Example: ["campaign"]
titlestring- Link title. Example: Spring sale
utm_campaignstring- set utm_campaign parameter to destination link. Example: spring
utm_contentstring- set utm_content parameter to destination link. Example: header
utm_mediumstring- set utm_medium parameter to destination link. Example: email
utm_sourcestring- set utm_source parameter to destination link. Example: newsletter
utm_termstring- set utm_term parameter to destination link. Example: shoes
shortio_links_bulk_createCreate up to 1000 short links on one domain in a single call.WriteCreate Links in Bulk
Create up to 1000 short links on one domain in a single call. Each link takes the same fields as shortio_link_create (originalURL is required).
Inputs
domainstringrequired- Domain hostname. Example: go.example.com
linksarrayrequired- Links to create (up to 1000) Example: [{"originalURL": "https://example.com/a"}, {"originalURL": "https://example.com/b"}]
allow_duplicatesboolean- Allow duplicate destinations across the batch. Example: false
folder_idstring- Folder ID. Example: fld_01HZX5K9
shortio_bundle_deleteDelete a link bundle.DestructiveDelete Bundle
Delete a link bundle. Get the bundle ID from shortio_bundle_create.
- Idempotent
Inputs
idstringrequired- Bundle ULID id. Example: 01HZX5K9ABCDEF1234567890
shortio_link_country_deleteRemove a link's country-specific destination.DestructiveDelete Link Country Target
Remove a link's country-specific destination. Get the link ID (lnk_...) from shortio_links_list or shortio_link_expand.
- Idempotent
Inputs
countrystringrequired- Country code. Example: USone of
ADAEAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZWEUQFQSQEQOQNQTXK link_idstringrequired- Numeric link ID or encoded link ID string. Example: lnk_4Lx2_aBcD3fGh1
domain_idstring- Domain ID, required only when using a legacy numeric link ID. Example: 123456
shortio_link_deleteDelete a short link permanently.DestructiveDelete Link
Delete a short link permanently. The short URL stops redirecting. Returns success, idString, error. Use shortio_link_archive to hide it instead. Get the link ID (lnk_...) from shortio_links_list or shortio_link_expand.
- Idempotent
Inputs
link_idstringrequired- Link ID. Example: lnk_4Lx2_aBcD3fGh1
shortio_link_permission_deleteRevoke a team member's access to a link.DestructiveDelete Link Permission
Revoke a team member's access to a link. Returns success. Get the link ID (lnk_...) from shortio_links_list or shortio_link_expand.
- Idempotent
Inputs
domain_idintegerrequired- Domain ID the link belongs to. Example: 123456
link_idstringrequired- Numeric link ID or encoded link ID string. Example: lnk_4Lx2_aBcD3fGh1
user_idstringrequired- User ID whose permission is being revoked. Example: 98765
shortio_link_region_deleteRemove a link's region-specific destination.DestructiveDelete Link Region Target
Remove a link's region-specific destination. Get the link ID (lnk_...) from shortio_links_list or shortio_link_expand.
- Idempotent
Inputs
countrystringrequired- Country code. Example: USone of
ADAEAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZWEUQFQSQEQOQNQTXK link_idstringrequired- Numeric link ID or encoded link ID string. Example: lnk_4Lx2_aBcD3fGh1
regionstringrequired- ISO 3166-2 region code. Example: US-CA
domain_idstring- Domain ID, required only when using a legacy numeric link ID. Example: 123456
shortio_links_bulk_deleteDelete several short links at once by ID (rate limit 1 per second).DestructiveDelete Links in Bulk
Delete several short links at once by ID (rate limit 1 per second). Returns success, error. Use shortio_link_delete for one link.
- Idempotent
Inputs
link_idsarrayrequired- Encoded link IDs to delete. Example: ["lnk_4Lx2_aBcD3fGh1"]
No tools match.