Skip to content
Changelog

Report a bug

Short Io integration: operations for AI agents

Short Io connects to Type.com as an integration. This page lists the 110 operations documented for Claude and Codex in Type.com: 35 read, 45 write, 30 destructive.

About Short Io

Short.io is a URL shortening service that allows users to create branded short links, manage them, and track their performance.

Categories: Marketing & Social

How to connect Short Io to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

110 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

110 operations listed.

Organizations

  • Read

    Get organization plan and usage

    Returns the organization's plan tier and billing period alongside its current usage counters: domain and link counts, paid link count, AI spend in microdollars, stored bytes, remaining Pro/Team trial days, the plan's folder limit per domain (null when unlimited), and nextLinkLimitRecalculationAt: the date (YYYY-MM-DD) the yearly link limit is next recalculated, one year after the last recalculation, else after the first payment, else after the organization registration. Request contract: path.organizationId: required; ; type="string".

    GET /organizations/{organizationId}/planInfo

Link queries

  • Read

    Fetch and inspect OpenGraph tags for a URL (public, hCaptcha-protected)

    Request contract: body(application/json): required; type="object"; body(application/json).hcaptchaToken: required; type="string"; hCaptcha verification token. Successful response contract: response200(application/json): type="object"; response200(application/json).title: required; HTML document title, if present; anyOf=[type="string" | type="null"]; response200(application/json).ogTags: type="array"; OpenGraph tags extracted from the page; items(type="object"; OpenGraph tag); response200(application/json).ogTags[].propertyName: required; type="string"; OpenGraph property name; response200(application/json).ogTags[].propertyValue: required; type="string"; OpenGraph property value.

    POST /links/opengraph/debug

  • Read

    Get link opengraph properties

    Request contract: path.domainId: required; Domain ID the link belongs to; type="number"; path.linkId: required; Numeric link ID or encoded link ID string; type="string".

    GET /links/opengraph/{domainId}/{linkId}

  • Read

    Fetch and inspect deep link configuration for a URL (public, hCaptcha-protected)

    Request contract: body(application/json): required; type="object"; body(application/json).hcaptchaToken: required; type="string"; hCaptcha verification token. Successful response contract: response200(application/json): type="object"; response200(application/json).domain: required; type="string"; Hostname inspected; response200(application/json).apple: required; type="object"; Apple universal link configuration; response200(application/json).apple.found: required; type="boolean"; Whether apple-app-site-association was found; response200(application/json).apple.data: required; Parsed apple-app-site-association contents; response200(application/json).apple.error: required; Error while fetching, if any; anyOf=[type="string" | type="null"]; response200(application/json).android: required; type="object"; Android app link configuration; response200(application/json).android.found: required; type="boolean"; Whether assetlinks.json was found; response200(application/json).android.data: required; Parsed assetlinks.json contents; response200(application/json).android.error: required; Error while fetching, if any; anyOf=[type="string" | type="null"].

    POST /links/deeplinks/debug

  • Read

    Get link info by link id

    Get link info by link id. Rate limit: 20/s Request contract: query.domainId: [DEPRECATED] Domain ID; type="string"; path.linkId: required; Numeric link ID or encoded link ID string; type="string"; pattern="(?:lnk|link)_\\w+|\\d+". Successful response contract: response200(application/json): allOf=[type="object" | type="object"]; response200(application/json).originalURL: required; type="string"; Original URL; response200(application/json).cloaking: type="boolean"; Cloaking; response200(application/json).password: type="string"; Link password; response200(application/json).expiresAt: Link expiration date in milliseconds or ISO string; anyOf=[type="integer"; nullable=true | type="string"; format="iso-date-time"; nullable=true]; response200(application/json).expiredURL: type="string"; nullable=true; Expired URL; response200(application/json).title: type="string"; Link title; response200(application/json).tags: type="array"; Array of link tags; items(type="string"); response200(application/json).utmSource: type="string"; set utm_source parameter to destination link; response200(application/json).utmMedium: type="string"; set utm_medium parameter to destination link; response200(application/json).utmCampaign: type="string"; set utm_campaign parameter to destination link; response200(application/json).utmTerm: type="string"; set utm_term parameter to destination link; response200(application/json).utmContent: type="string"; set utm_content parameter to destination link; response200(application/json).ttl: Time to live in milliseconds or ISO string; anyOf=[type="string"; format="iso-date-time"; nullable=true | type="integer"; nullable=true]; response200(application/json).androidURL: type="string"; nullable=true; Android URL; response200(application/json).iphoneURL: type="string"; nullable=true; iPhone URL; response200(application/json).clicksLimit: type="integer"; minimum=1; nullable=true; disable link after specified number of clicks; response200(application/json).passwordContact: type="boolean"; nullable=true; Provide your email to users to get a password; response200(application/json).skipQS: type="boolean"; default=false; Skip query string merging; response200(application/json).archived: type="boolean"; default=false; Link is archived; response200(application/json).splitURL: type="string"; nullable=true; Split URL; response200(application/json).splitPercent: type="integer"; minimum=1; maximum=100; nullable=true; Split URL percentage; response200(application/json).splitURLV2: type="array"; maxItems=10; nullable=true; Split URL configurations for multi-way A/B testing; items(type="object"); response200(application/json).splitURLV2[].url: required; type="string"; Split URL destination; response200(application/json).splitURLV2[].percent: required; type="integer"; minimum=1; maximum=100; Traffic percentage; response200(application/json).integrationAdroll: type="string"; nullable=true; Adroll integration; response200(application/json).integrationFB: type="string"; nullable=true; Facebook integration; response200(application/json).integrationTT: type="string"; nullable=true; TikTok integration; response200(application/json).integrationGA: type="string"; nullable=true; Google Analytics integration; response200(application/json).integrationGTM: type="string"; nullable=true; Google Tag Manager integration; response200(application/json).languages: Destinations by visitor browser language (Accept-Language). Keys are a language (`en`) or a language and region (`en_US`, `en-us` is accepted); the most specific match wins. Replaced as a whole on update; `{}` or `null` removes every rule. Requires the Hobby plan.; anyOf=[type="object" | type="null"]; response200(application/json).languages anyOf1.{key}: type="string"; response200(application/json).idString: required; type="string"; Link ID; response200(application/json).id: required; type="string"; Link ID; response200(application/json).shortURL: required; type="string"; Short URL; response200(application/json).secureShortURL: required; type="string"; Secure short URL; response200(application/json).path: required; anyOf=[type="string"; Link slug. For case-insensitive domains, this is the normalized lowercase version of the path. | type="null"]; response200(application/json).displayPath: required; anyOf=[type="string"; Original path preserving the case as provided during creation. Set only for case-insensitive domains when the path contains uppercase characters, otherwise null. | type="null"]; response200(application/json).redirectType: type="string"; enum=["301","302","307","308"]; HTTP code for redirect; response200(application/json).createdAt: required; Link creation date in ISO format; anyOf=[type="string"; format="iso-date-time" | type="null"]; response200(application/json).updatedAt: required; Link last update date in ISO format; anyOf=[type="string"; format="iso-date-time" | type="null"]; response200(application/json).FolderId: anyOf=[type="string"; Folder ID | type="null"]; response200(application/json).DomainId: type="integer"; Domain ID; response200(application/json).OwnerId: type="integer"; Owner ID; response200(application/json).hasPassword: type="boolean"; default=false; Link has password; response200(application/json).source: enum=["website","api","public","spreadsheets","slack","telegram",""]; Link source; response200(application/json).pageType: type="integer"; enum=[1,2,3]; Special page type rendered at the short link: 1 = bundle, 2 = post, 3 = page. Absent for normal redirect links.; response200(application/json).User: anyOf=[type="object" | type="null"]; response200(application/json).User anyOf1.id: required; type="integer"; Creator user ID; response200(application/json).User anyOf1.name: required; anyOf=[type="string"; Creator name | type="null"]; response200(application/json).User anyOf1.email: required; type="string"; Creator email; response200(application/json).User anyOf1.photoURL: required; anyOf=[type="string"; User photo URL | type="null"].

    GET /links/{linkId}

  • Read

    Get link info by path

    Get link info by path. Returns 404 if the domain does not exist in your organization. Rate limit: 20/s Request contract: query.domain: required; Domain hostname; type="string"; query.path: required; Link path; type="string". Successful response contract: response200(application/json): allOf=[type="object" | type="object"]; response200(application/json).originalURL: required; type="string"; Original URL; response200(application/json).cloaking: type="boolean"; Cloaking; response200(application/json).password: type="string"; Link password; response200(application/json).expiresAt: Link expiration date in milliseconds or ISO string; anyOf=[type="integer"; nullable=true | type="string"; format="iso-date-time"; nullable=true]; response200(application/json).expiredURL: type="string"; nullable=true; Expired URL; response200(application/json).title: type="string"; Link title; response200(application/json).tags: type="array"; Array of link tags; items(type="string"); response200(application/json).utmSource: type="string"; set utm_source parameter to destination link; response200(application/json).utmMedium: type="string"; set utm_medium parameter to destination link; response200(application/json).utmCampaign: type="string"; set utm_campaign parameter to destination link; response200(application/json).utmTerm: type="string"; set utm_term parameter to destination link; response200(application/json).utmContent: type="string"; set utm_content parameter to destination link; response200(application/json).ttl: Time to live in milliseconds or ISO string; anyOf=[type="string"; format="iso-date-time"; nullable=true | type="integer"; nullable=true]; response200(application/json).androidURL: type="string"; nullable=true; Android URL; response200(application/json).iphoneURL: type="string"; nullable=true; iPhone URL; response200(application/json).clicksLimit: type="integer"; minimum=1; nullable=true; disable link after specified number of clicks; response200(application/json).passwordContact: type="boolean"; nullable=true; Provide your email to users to get a password; response200(application/json).skipQS: type="boolean"; default=false; Skip query string merging; response200(application/json).archived: type="boolean"; default=false; Link is archived; response200(application/json).splitURL: type="string"; nullable=true; Split URL; response200(application/json).splitPercent: type="integer"; minimum=1; maximum=100; nullable=true; Split URL percentage; response200(application/json).splitURLV2: type="array"; maxItems=10; nullable=true; Split URL configurations for multi-way A/B testing; items(type="object"); response200(application/json).splitURLV2[].url: required; type="string"; Split URL destination; response200(application/json).splitURLV2[].percent: required; type="integer"; minimum=1; maximum=100; Traffic percentage; response200(application/json).integrationAdroll: type="string"; nullable=true; Adroll integration; response200(application/json).integrationFB: type="string"; nullable=true; Facebook integration; response200(application/json).integrationTT: type="string"; nullable=true; TikTok integration; response200(application/json).integrationGA: type="string"; nullable=true; Google Analytics integration; response200(application/json).integrationGTM: type="string"; nullable=true; Google Tag Manager integration; response200(application/json).languages: Destinations by visitor browser language (Accept-Language). Keys are a language (`en`) or a language and region (`en_US`, `en-us` is accepted); the most specific match wins. Replaced as a whole on update; `{}` or `null` removes every rule. Requires the Hobby plan.; anyOf=[type="object" | type="null"]; response200(application/json).languages anyOf1.{key}: type="string"; response200(application/json).idString: required; type="string"; Link ID; response200(application/json).id: required; type="string"; Link ID; response200(application/json).shortURL: required; type="string"; Short URL; response200(application/json).secureShortURL: required; type="string"; Secure short URL; response200(application/json).path: required; anyOf=[type="string"; Link slug. For case-insensitive domains, this is the normalized lowercase version of the path. | type="null"]; response200(application/json).displayPath: required; anyOf=[type="string"; Original path preserving the case as provided during creation. Set only for case-insensitive domains when the path contains uppercase characters, otherwise null. | type="null"]; response200(application/json).redirectType: type="string"; enum=["301","302","307","308"]; HTTP code for redirect; response200(application/json).createdAt: required; Link creation date in ISO format; anyOf=[type="string"; format="iso-date-time" | type="null"]; response200(application/json).updatedAt: required; Link last update date in ISO format; anyOf=[type="string"; format="iso-date-time" | type="null"]; response200(application/json).FolderId: anyOf=[type="string"; Folder ID | type="null"]; response200(application/json).DomainId: type="integer"; Domain ID; response200(application/json).OwnerId: type="integer"; Owner ID; response200(application/json).hasPassword: type="boolean"; default=false; Link has password; response200(application/json).source: enum=["website","api","public","spreadsheets","slack","telegram",""]; Link source; response200(application/json).pageType: type="integer"; enum=[1,2,3]; Special page type rendered at the short link: 1 = bundle, 2 = post, 3 = page. Absent for normal redirect links.; response200(application/json).User: anyOf=[type="object" | type="null"]; response200(application/json).User anyOf1.id: required; type="integer"; Creator user ID; response200(application/json).User anyOf1.name: required; anyOf=[type="string"; Creator name | type="null"]; response200(application/json).User anyOf1.email: required; type="string"; Creator email; response200(application/json).User anyOf1.photoURL: required; anyOf=[type="string"; User photo URL | type="null"].

    GET /links/expand

  • Read

    Get link info by original URL

    **DEPRECATED** Get link info by original URL. Returns 404 if the domain does not exist in your organization. Rate limit: 20/s Request contract: query.domain: required; Domain hostname; type="string"; query.originalURL: required; Link original URL; type="string".

    GET /links/by-original-url

  • Read

    Get links info by original URL

    Returns all links with the same original URL. Returns 404 if the domain does not exist in your organization. Request contract: query.domain: required; Domain hostname; type="string"; query.originalURL: required; Link original URL; type="string".

    GET /links/multiple-by-url

  • Read

    Get domainId

    Get links folders for the specified domain id Request contract: path.domainId: required; Domain ID to list folders for; type="integer".

    GET /links/folders/{domainId}

  • Read

    Get folderId

    Get links folder for the specified domain id and user id Request contract: path.domainId: required; Domain ID the folder belongs to; type="integer"; path.folderId: required; Folder ID; type="string".

    GET /links/folders/{domainId}/{folderId}

  • Write

    Create folders

    Create a new folder Request contract: body(application/json): required; type="object"; body(application/json).domainId: required; type="integer"; Domain ID the folder belongs to; body(application/json).name: required; type="string"; Folder display name; body(application/json).color: type="string"; Folder display hex color; body(application/json).backgroundColor: type="string"; QR code background hex color; body(application/json).logoUrl: type="string"; URL of the QR code center logo; body(application/json).logoHeight: type="integer"; QR code logo height in pixels; body(application/json).logoWidth: type="integer"; QR code logo width in pixels; body(application/json).ecLevel: type="string"; QR code error correction level; body(application/json).borderRadius: type="integer"; QR code border radius in pixels; body(application/json).noExcavate: type="boolean"; Disable logo excavation (cutout); body(application/json).finderOuterShape: type="string"; Shape of the outer finder pattern; body(application/json).finderInnerShape: type="string"; Shape of the inner finder pattern; body(application/json).finderColor: type="string"; Hex color for finder patterns; body(application/json).cornerMode: type="string"; Corner rendering mode; body(application/json).labelText: type="string"; QR code label text; body(application/json).labelStyle: type="string"; Label placement style; body(application/json).labelColor: type="string"; Label text hex color; body(application/json).labelBgColor: type="string"; Label background hex color; body(application/json).labelFontSize: type="integer"; Label font size in pixels; body(application/json).labelFontFamily: type="string"; Label font family; body(application/json).integrationFB: type="string"; Facebook Pixel ID; body(application/json).integrationTT: type="string"; TikTok Pixel ID; body(application/json).integrationGA: type="string"; Google Analytics ID; body(application/json).integrationGTM: type="string"; Google Tag Manager ID; body(application/json).integrationAdroll: type="string"; Adroll pixel ID; body(application/json).utmCampaign: type="string"; Default utm_campaign for folder links; body(application/json).utmMedium: type="string"; Default utm_medium for folder links; body(application/json).utmSource: type="string"; Default utm_source for folder links; body(application/json).utmTerm: type="string"; Default utm_term for folder links; body(application/json).utmContent: type="string"; Default utm_content for folder links; body(application/json).redirectType: type="integer"; Default HTTP redirect code for folder links; body(application/json).expiresAtDays: type="integer"; Default link lifetime in days; body(application/json).icon: type="string"; Folder icon identifier; body(application/json).prefix: type="string"; Slug prefix applied to folder links.

    POST /links/folders

Link Management

  • Read

    Get link permissions

    Request contract: path.domainId: required; Domain ID the link belongs to; type="string"; path.linkId: required; Numeric link ID or encoded link ID string; type="string". Successful response contract: response200(application/json): type="array"; List of permissions granted on the link; items(type="object"; Link permission record); response200(application/json)[].id: required; type="string"; Permission record ID; response200(application/json)[].DomainId: required; type="integer"; Domain ID; response200(application/json)[].UserId: required; type="integer"; User ID granted access; response200(application/json)[].LinkIdString: required; type="string"; Encoded link ID the permission applies to.

    GET /links/permissions/{domainId}/{linkId}

  • Read

    List hosted QR codes

    Request contract: query.domainId: required; Domain ID to list hosted QR codes for; type="number"; query.linkIdString: Link ID; type="string"; pattern="(?:lnk|link)_[0-9a-zA-Z]+_[0-9a-zA-Z]+"; query.limit: required; ; type="number"; default=50; minimum=1; maximum=200; query.pageToken: Cursor from the previous page's nextPageToken; type="string".

    GET /links/qr/hosted

  • Read

    List the tags used across a domain

    Request contract: query.prefix: Return only tags starting with this prefix; type="string"; query.limit: Max tags to return; type="integer"; minimum=1; maximum=300; query.pageToken: Opaque cursor for the next page of tags; type="string"; path.domainId: required; Domain ID; type="string"; pattern="\\d+". Successful response contract: response200(application/json): type="object"; response200(application/json).tags: required; type="array"; Tags with their link counts; items(type="object"); response200(application/json).tags[].name: required; type="string"; response200(application/json).tags[].count: required; type="integer"; response200(application/json).nextPageToken: required; Cursor for the next page, or null if no more results; anyOf=[type="string" | type="null"].

    GET /tags/{domainId}

  • Read

    Get the most popular tags in a domain

    Request contract: query.limit: Max tags to return; type="integer"; minimum=1; maximum=100; path.domainId: required; Domain ID; type="string"; pattern="\\d+". Successful response contract: response200(application/json): type="object"; response200(application/json).tags: required; type="array"; Tags ordered by link count descending; items(type="object"); response200(application/json).tags[].name: required; type="string"; response200(application/json).tags[].count: required; type="integer".

    GET /tags/{domainId}/popular

  • Write

    Set link opengraph properties

    Request contract: path.domainId: required; Domain ID the link belongs to; type="number"; path.linkId: required; Numeric link ID or encoded link ID string; type="string"; body(application/json): required; type="array"; items(type="array"; minItems=2).

    PUT /links/opengraph/{domainId}/{linkId}

  • Write

    Add link permission

    Request contract: path.domainId: required; Domain ID the link belongs to; type="string"; path.linkId: required; Link ID; type="string"; pattern="(?:lnk|link)_[0-9a-zA-Z]+_[0-9a-zA-Z]+"; path.userId: required; User ID to grant access to; type="string". Successful response contract: response201(application/json): type="object"; response201(application/json).id: required; type="string"; Permission record ID; response201(application/json).DomainId: required; type="integer"; Domain ID; response201(application/json).UserId: required; type="integer"; User ID granted access; response201(application/json).LinkIdString: required; type="string"; pattern="(?:lnk|link)_[0-9a-zA-Z]+_[0-9a-zA-Z]+"; Link ID.

    POST /links/permissions/{domainId}/{linkId}/{userId}

  • Write

    Generate QR code for the link

    Request contract: path.linkIdString: required; Link ID; type="string"; pattern="(?:lnk|link)_[0-9a-zA-Z]+_[0-9a-zA-Z]+"; header.accept: Accept header; use application/json to receive a hosted URL; type="string"; body(application/json): required; type="object"; body(application/json).color: type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA); body(application/json).backgroundColor: type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA); body(application/json).size: type="number"; minimum=1; maximum=99; QR code size scale factor; body(application/json).type: type="string"; enum=["png","svg"]; default="png"; QR code image format; body(application/json).useDomainSettings: required; type="boolean"; default=true; Use QR code settings configured on the domain; body(application/json).borderRadius: type="number"; minimum=0; maximum=5; Dot border radius on the dashboard 0-5 scale, 5 = fully round; body(application/json).noExcavate: type="boolean"; Disable logo excavation (cutout) in the QR code; body(application/json).finderOuterShape: enum=["square","rounded","circle","drop"]; Shape of the outer finder pattern; body(application/json).finderInnerShape: enum=["square","rounded","circle","drop"]; Shape of the inner finder pattern; body(application/json).finderColor: type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA); body(application/json).cornerMode: enum=["individual","merge"]; Corner module rendering mode; body(application/json).labelText: type="string"; maxLength=255; Optional text label rendered with the QR code; body(application/json).labelStyle: enum=["below","pill","box"]; Label visual style; body(application/json).labelColor: type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA); body(application/json).labelBgColor: type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA); body(application/json).labelFontSize: type="number"; minimum=1; maximum=20; Label font size in module units (rendered px = value * block size); body(application/json).labelFontFamily: type="string"; maxLength=255; Label font family name.

    POST /links/qr/{linkIdString}

  • Write

    Generate a hosted QR code for the link

    Request contract: path.linkIdString: required; Link ID; type="string"; pattern="(?:lnk|link)_[0-9a-zA-Z]+_[0-9a-zA-Z]+"; body(application/json): required; type="object"; body(application/json).color: type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA); body(application/json).backgroundColor: type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA); body(application/json).size: type="number"; minimum=1; maximum=99; QR code size scale factor; body(application/json).type: type="string"; enum=["png","svg"]; default="png"; QR code image format; body(application/json).useDomainSettings: required; type="boolean"; default=true; Use QR code settings configured on the domain; body(application/json).borderRadius: type="number"; minimum=0; maximum=5; Dot border radius on the dashboard 0-5 scale, 5 = fully round; body(application/json).noExcavate: type="boolean"; Disable logo excavation (cutout) in the QR code; body(application/json).finderOuterShape: enum=["square","rounded","circle","drop"]; Shape of the outer finder pattern; body(application/json).finderInnerShape: enum=["square","rounded","circle","drop"]; Shape of the inner finder pattern; body(application/json).finderColor: type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA); body(application/json).cornerMode: enum=["individual","merge"]; Corner module rendering mode; body(application/json).labelText: type="string"; maxLength=255; Optional text label rendered with the QR code; body(application/json).labelStyle: enum=["below","pill","box"]; Label visual style; body(application/json).labelColor: type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA); body(application/json).labelBgColor: type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA); body(application/json).labelFontSize: type="number"; minimum=1; maximum=20; Label font size in module units (rendered px = value * block size); body(application/json).labelFontFamily: type="string"; maxLength=255; Label font family name.

    POST /links/qr/{linkIdString}/hosted

  • Write

    Generate QR codes for the link in bulk

    Generate QR codes for the link in bulk. Rate limit - 1 request per minute Request contract: body(application/json): required; type="object"; body(application/json).color: type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA); body(application/json).backgroundColor: type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA); body(application/json).size: type="number"; minimum=1; maximum=99; QR code size scale factor; body(application/json).type: required; type="string"; enum=["png","svg"]; default="png"; QR code image format; body(application/json).useDomainSettings: required; type="boolean"; default=true; Use QR code settings configured on the domain; body(application/json).borderRadius: type="number"; minimum=0; maximum=5; Dot border radius on the dashboard 0-5 scale, 5 = fully round; body(application/json).noExcavate: type="boolean"; Disable logo excavation (cutout) in the QR code; body(application/json).finderOuterShape: enum=["square","rounded","circle","drop"]; Shape of the outer finder pattern; body(application/json).finderInnerShape: enum=["square","rounded","circle","drop"]; Shape of the inner finder pattern; body(application/json).finderColor: type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA); body(application/json).cornerMode: enum=["individual","merge"]; Corner module rendering mode; body(application/json).labelText: type="string"; maxLength=255; Optional text label rendered with the QR code; body(application/json).labelStyle: enum=["below","pill","box"]; Label visual style; body(application/json).labelColor: type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA); body(application/json).labelBgColor: type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA); body(application/json).labelFontSize: type="number"; minimum=1; maximum=20; Label font size in module units (rendered px = value * block size); body(application/json).labelFontFamily: type="string"; maxLength=255; Label font family name; body(application/json).linkIds: required; type="array"; maxItems=150; List of link IDs to generate QR codes for; items(type="string"; pattern="^(\\d+|(?:lnk|link)_\\w+)$"; Link ID or encoded link ID string); body(application/json).domainId: type="string"; Domain ID for legacy numeric link IDs. Successful response contract: response201(application/json): ZIP file containing QR codes.

    POST /links/qr/bulk

  • Write

    Generate an AI QR code for the link

    Request contract: path.linkIdString: required; Link ID; type="string"; pattern="(?:lnk|link)_[0-9a-zA-Z]+_[0-9a-zA-Z]+"; body(application/json): required; type="object"; body(application/json).prompt: required; type="string"; minLength=3; maxLength=500; pattern="^[^\\p{Cc}]+$"; Description of the artwork to generate; body(application/json).negativePrompt: type="string"; maxLength=500; pattern="^[^\\p{Cc}]*$"; Extra things to avoid in the artwork; body(application/json).seed: type="integer"; minimum=0; maximum=2147483647; Seed for a reproducible composition.

    POST /links/qr/{linkIdString}/ai

  • Write

    Create a new link

    This method creates a new link. If parameter "path" is omitted, it generates path by algorithm, chosen in domain settings. Notes: 1. If URL with a given path already exists and originalURL of the URL in database is equal to originalURL argument, it returns information about existing URL 2. If URL with a given path already exists and originalURL is different from originalURL in database, it returns error with a status `409` 3. If URL with a given originalURL exists, and no path is given, it returns information about existing URL and does not create anything 4. If URL with a given originalURL exists, and custom path is given, it creates a new short URL Returns 404 if the domain does not exist in your organization. **Rate limit**: 50/s Request contract: body(application/json): required; allOf=[type="object" | type="object"]; body(application/json).originalURL: required; type="string"; Original URL; body(application/json).cloaking: type="boolean"; Cloaking; body(application/json).password: type="string"; Link password; body(application/json).redirectType: type="integer"; enum=[301,302,307,308]; nullable=true; HTTP code for redirect; body(application/json).expiresAt: Link expiration date in milliseconds or ISO string; anyOf=[type="integer"; nullable=true | type="string"; format="iso-date-time"; nullable=true]; body(application/json).expiredURL: type="string"; nullable=true; Expired URL; body(application/json).title: type="string"; Link title; body(application/json).tags: type="array"; Array of link tags; items(type="string"); body(application/json).utmSource: type="string"; set utm_source parameter to destination link; body(application/json).utmMedium: type="string"; set utm_medium parameter to destination link; body(application/json).utmCampaign: type="string"; set utm_campaign parameter to destination link; body(application/json).utmTerm: type="string"; set utm_term parameter to destination link; body(application/json).utmContent: type="string"; set utm_content parameter to destination link; body(application/json).ttl: Time to live in milliseconds or ISO string; anyOf=[type="string"; format="iso-date-time"; nullable=true | type="integer"; nullable=true]; body(application/json).path: type="string"; nullable=true; Link slug. For case-insensitive domains, the path is normalized to lowercase and the original value is preserved in displayPath.; body(application/json).androidURL: type="string"; nullable=true; Android URL; body(application/json).iphoneURL: type="string"; nullable=true; iPhone URL; body(application/json).createdAt: Link creation date in milliseconds; anyOf=[type="integer"; nullable=true | type="string"; format="iso-date-time"; nullable=true]; body(application/json).clicksLimit: type="integer"; minimum=1; nullable=true; disable link after specified number of clicks; body(application/json).passwordContact: type="boolean"; nullable=true; Provide your email to users to get a password; body(application/json).skipQS: type="boolean"; default=false; Skip query string merging; body(application/json).archived: type="boolean"; default=false; Link is archived; body(application/json).splitURL: type="string"; nullable=true; Split URL; body(application/json).splitPercent: type="integer"; minimum=1; maximum=100; nullable=true; Split URL percentage; body(application/json).splitURLV2: type="array"; maxItems=10; nullable=true; Split URL configurations for multi-way A/B testing; items(type="object"); body(application/json).splitURLV2[].url: required; type="string"; Split URL destination; body(application/json).splitURLV2[].percent: required; type="integer"; minimum=1; maximum=100; Traffic percentage; body(application/json).integrationAdroll: type="string"; nullable=true; Adroll integration; body(application/json).integrationFB: type="string"; nullable=true; Facebook integration; body(application/json).integrationTT: type="string"; nullable=true; TikTok integration; body(application/json).integrationGA: type="string"; nullable=true; Google Analytics integration; body(application/json).integrationGTM: type="string"; nullable=true; Google Tag Manager integration; body(application/json).languages: Destinations by visitor browser language (Accept-Language). Keys are a language (`en`) or a language and region (`en_US`, `en-us` is accepted); the most specific match wins. Replaced as a whole on update; `{}` or `null` removes every rule. Requires the Hobby plan.; anyOf=[type="object" | type="null"]; body(application/json).languages anyOf1.{key}: type="string"; body(application/json).domain: required; type="string"; format="hostname"; Domain hostname; body(application/json).allowDuplicates: type="boolean"; default=false; Allow duplicates; body(application/json).folderId: type="string"; Folder ID; body(application/json).skipQS: type="boolean"; Skip query string merging. Successful response contract: response200(application/json): allOf=[allOf=[type="object" | type="object"] | type="object"]; response200(application/json).originalURL: required; type="string"; Original URL; response200(application/json).cloaking: type="boolean"; Cloaking; response200(application/json).password: type="string"; Link password; response200(application/json).expiresAt: Link expiration date in milliseconds or ISO string; anyOf=[type="integer"; nullable=true | type="string"; format="iso-date-time"; nullable=true]; response200(application/json).expiredURL: type="string"; nullable=true; Expired URL; response200(application/json).title: type="string"; Link title; response200(application/json).tags: type="array"; Array of link tags; items(type="string"); response200(application/json).utmSource: type="string"; set utm_source parameter to destination link; response200(application/json).utmMedium: type="string"; set utm_medium parameter to destination link; response200(application/json).utmCampaign: type="string"; set utm_campaign parameter to destination link; response200(application/json).utmTerm: type="string"; set utm_term parameter to destination link; response200(application/json).utmContent: type="string"; set utm_content parameter to destination link; response200(application/json).ttl: Time to live in milliseconds or ISO string; anyOf=[type="string"; format="iso-date-time"; nullable=true | type="integer"; nullable=true]; response200(application/json).androidURL: type="string"; nullable=true; Android URL; response200(application/json).iphoneURL: type="string"; nullable=true; iPhone URL; response200(application/json).clicksLimit: type="integer"; minimum=1; nullable=true; disable link after specified number of clicks; response200(application/json).passwordContact: type="boolean"; nullable=true; Provide your email to users to get a password; response200(application/json).skipQS: type="boolean"; default=false; Skip query string merging; response200(application/json).archived: type="boolean"; default=false; Link is archived; response200(application/json).splitURL: type="string"; nullable=true; Split URL; response200(application/json).splitPercent: type="integer"; minimum=1; maximum=100; nullable=true; Split URL percentage; response200(application/json).splitURLV2: type="array"; maxItems=10; nullable=true; Split URL configurations for multi-way A/B testing; items(type="object"); response200(application/json).splitURLV2[].url: required; type="string"; Split URL destination; response200(application/json).splitURLV2[].percent: required; type="integer"; minimum=1; maximum=100; Traffic percentage; response200(application/json).integrationAdroll: type="string"; nullable=true; Adroll integration; response200(application/json).integrationFB: type="string"; nullable=true; Facebook integration; response200(application/json).integrationTT: type="string"; nullable=true; TikTok integration; response200(application/json).integrationGA: type="string"; nullable=true; Google Analytics integration; response200(application/json).integrationGTM: type="string"; nullable=true; Google Tag Manager integration; response200(application/json).languages: Destinations by visitor browser language (Accept-Language). Keys are a language (`en`) or a language and region (`en_US`, `en-us` is accepted); the most specific match wins. Replaced as a whole on update; `{}` or `null` removes every rule. Requires the Hobby plan.; anyOf=[type="object" | type="null"]; response200(application/json).languages anyOf1.{key}: type="string"; response200(application/json).idString: required; type="string"; Link ID; response200(application/json).id: required; type="string"; Link ID; response200(application/json).shortURL: required; type="string"; Short URL; response200(application/json).secureShortURL: required; type="string"; Secure short URL; response200(application/json).path: required; anyOf=[type="string"; Link slug. For case-insensitive domains, this is the normalized lowercase version of the path. | type="null"]; response200(application/json).displayPath: required; anyOf=[type="string"; Original path preserving the case as provided during creation. Set only for case-insensitive domains when the path contains uppercase characters, otherwise null. | type="null"]; response200(application/json).redirectType: type="string"; enum=["301","302","307","308"]; HTTP code for redirect; response200(application/json).createdAt: required; Link creation date in ISO format; anyOf=[type="string"; format="iso-date-time" | type="null"]; response200(application/json).updatedAt: required; Link last update date in ISO format; anyOf=[type="string"; format="iso-date-time" | type="null"]; response200(application/json).FolderId: anyOf=[type="string"; Folder ID | type="null"]; response200(application/json).DomainId: type="integer"; Domain ID; response200(application/json).OwnerId: type="integer"; Owner ID; response200(application/json).hasPassword: type="boolean"; default=false; Link has password; response200(application/json).source: enum=["website","api","public","spreadsheets","slack","telegram",""]; Link source; response200(application/json).pageType: type="integer"; enum=[1,2,3]; Special page type rendered at the short link: 1 = bundle, 2 = post, 3 = page. Absent for normal redirect links.; response200(application/json).User: anyOf=[type="object" | type="null"]; response200(application/json).User anyOf1.id: required; type="integer"; Creator user ID; response200(application/json).User anyOf1.name: required; anyOf=[type="string"; Creator name | type="null"]; response200(application/json).User anyOf1.email: required; type="string"; Creator email; response200(application/json).User anyOf1.photoURL: required; anyOf=[type="string"; User photo URL | type="null"]; response200(application/json).success: type="boolean"; default=true; response200(application/json).duplicate: type="boolean"; default=false.

    POST /links

  • Write

    Unarchive link

    Request contract: body(application/json): required; type="object"; body(application/json).link_id: required; type="string"; Numeric link ID or encoded link ID string; body(application/json).domain_id: type="string"; Domain ID, required only when using a legacy numeric link ID. Successful response contract: response200(application/json): type="object"; response200(application/json).success: required; type="boolean"; Whether the operation succeeded; response200(application/json).error: type="string"; Error message when operation failed.

    POST /links/unarchive

  • Write

    Unarchive links in bulk

    Request contract: body(application/json): required; type="object"; body(application/json).link_ids: required; type="array"; maxItems=150; Link IDs to operate on; items(type="string"; Numeric link ID or encoded link ID string); body(application/json).domain_id: type="string"; Domain ID, required only when using legacy numeric link IDs. Successful response contract: response200(application/json): type="object"; response200(application/json).success: required; type="boolean"; Whether the operation succeeded; response200(application/json).error: type="string"; Error message when operation failed.

    POST /links/unarchive_bulk

  • Write

    Create a new link (simple version)

    Simple version of link create endpoint. You can use it if you can not use POST method Returns 404 if the domain does not exist in your organization. **Rate limit**: 50/s Request contract: query.domain: required; Domain hostname; type="string"; format="hostname"; query.path: Link path; type="string"; query.originalURL: required; Link original URL; type="string"; query.title: Link title; type="string"; query.urlOnly: ; anyOf=[type="string"; enum=["1"] | type="string"; enum=["0"] | type="boolean"; Return only URL]; query.apiKey: required; API key; type="string".

    GET /links/tweetbot

  • Write

    Create up to 1000 links in one call

    Please use this method if you need to create big packs of links. It accepts up to 1000 links in one API call. It works almost the same as single link creation endpoint, but accepts an array of URLs and returns an array of responses. Returns list of Link objects. If any URL is failed to insert, it returns error object instead as array element. Method is not transactional – it can insert some links from the list and return an error for others. Returns 404 if the domain does not exist in your organization. **Rate limit**: 5 queries in 10 seconds Request contract: body(application/json): required; type="object"; body(application/json).domain: required; type="string"; format="hostname"; Domain hostname; body(application/json).allowDuplicates: type="boolean"; default=false; Allow duplicate destinations across the batch; body(application/json).links: required; type="array"; Links to create (up to 1000); items(type="object"); body(application/json).links[].originalURL: required; type="string"; Original URL; body(application/json).links[].cloaking: type="boolean"; Cloaking; body(application/json).links[].password: type="string"; Link password; body(application/json).links[].redirectType: type="integer"; enum=[301,302,307,308]; nullable=true; HTTP code for redirect; body(application/json).links[].expiresAt: Link expiration date in milliseconds or ISO string; anyOf=[type="integer"; nullable=true | type="string"; format="iso-date-time"; nullable=true]; body(application/json).links[].expiredURL: type="string"; nullable=true; Expired URL; body(application/json).links[].title: type="string"; Link title; body(application/json).links[].tags: type="array"; Array of link tags; items(type="string"); body(application/json).links[].utmSource: type="string"; set utm_source parameter to destination link; body(application/json).links[].utmMedium: type="string"; set utm_medium parameter to destination link; body(application/json).links[].utmCampaign: type="string"; set utm_campaign parameter to destination link; body(application/json).links[].utmTerm: type="string"; set utm_term parameter to destination link; body(application/json).links[].utmContent: type="string"; set utm_content parameter to destination link; body(application/json).links[].ttl: Time to live in milliseconds or ISO string; anyOf=[type="string"; format="iso-date-time"; nullable=true | type="integer"; nullable=true]; body(application/json).links[].path: type="string"; nullable=true; Link slug. For case-insensitive domains, the path is normalized to lowercase and the original value is preserved in displayPath.; body(application/json).links[].androidURL: type="string"; nullable=true; Android URL; body(application/json).links[].iphoneURL: type="string"; nullable=true; iPhone URL; body(application/json).links[].createdAt: Link creation date in milliseconds; anyOf=[type="integer"; nullable=true | type="string"; format="iso-date-time"; nullable=true]; body(application/json).links[].clicksLimit: type="integer"; minimum=1; nullable=true; disable link after specified number of clicks; body(application/json).links[].passwordContact: type="boolean"; nullable=true; Provide your email to users to get a password; body(application/json).links[].skipQS: type="boolean"; default=false; Skip query string merging; body(application/json).links[].archived: type="boolean"; default=false; Link is archived; body(application/json).links[].splitURL: type="string"; nullable=true; Split URL; body(application/json).links[].splitPercent: type="integer"; minimum=1; maximum=100; nullable=true; Split URL percentage; body(application/json).links[].splitURLV2: type="array"; maxItems=10; nullable=true; Split URL configurations for multi-way A/B testing; items(type="object"); body(application/json).links[].splitURLV2[].percent: required; type="integer"; minimum=1; maximum=100; Traffic percentage; body(application/json).links[].integrationAdroll: type="string"; nullable=true; Adroll integration; body(application/json).links[].integrationFB: type="string"; nullable=true; Facebook integration; body(application/json).links[].integrationTT: type="string"; nullable=true; TikTok integration; body(application/json).links[].integrationGA: type="string"; nullable=true; Google Analytics integration; body(application/json).links[].integrationGTM: type="string"; nullable=true; Google Tag Manager integration; body(application/json).links[].languages: Destinations by visitor browser language (Accept-Language). Keys are a language (`en`) or a language and region (`en_US`, `en-us` is accepted); the most specific match wins. Replaced as a whole on update; `{}` or `null` removes every rule. Requires the Hobby plan.; anyOf=[type="object" | type="null"]; body(application/json).links[].languages anyOf1.{key}: type="string"; body(application/json).folderId: type="string"; Folder ID.

    POST /links/bulk

  • Write

    Generate example links for a domain

    Creates a set of demo/example links to showcase various features of the short link service. Example links include: - A/B testing with split URLs - Mobile targeting (different URLs for Android/iPhone) - Expiring links with time limits - File download links - Password-protected links Returns 404 if the domain does not exist in your organization. **Rate limit**: 5/10s Request contract: body(application/json): required; type="object"; body(application/json).domain: required; type="string"; format="hostname"; Domain hostname to create examples for. Successful response contract: response200(application/json): type="object"; response200(application/json).success: required; type="boolean"; Whether the example links were created; response200(application/json).links: required; type="array"; Created example links; items(allOf=[allOf=[type="object" | type="object"] | type="object"]); response200(application/json).links[].originalURL: required; type="string"; Original URL; response200(application/json).links[].cloaking: type="boolean"; Cloaking; response200(application/json).links[].password: type="string"; Link password; response200(application/json).links[].expiresAt: Link expiration date in milliseconds or ISO string; anyOf=[type="integer"; nullable=true | type="string"; format="iso-date-time"; nullable=true]; response200(application/json).links[].expiredURL: type="string"; nullable=true; Expired URL; response200(application/json).links[].title: type="string"; Link title; response200(application/json).links[].tags: type="array"; Array of link tags; items(type="string"); response200(application/json).links[].utmSource: type="string"; set utm_source parameter to destination link; response200(application/json).links[].utmMedium: type="string"; set utm_medium parameter to destination link; response200(application/json).links[].utmCampaign: type="string"; set utm_campaign parameter to destination link; response200(application/json).links[].utmTerm: type="string"; set utm_term parameter to destination link; response200(application/json).links[].utmContent: type="string"; set utm_content parameter to destination link; response200(application/json).links[].ttl: Time to live in milliseconds or ISO string; anyOf=[type="string"; format="iso-date-time"; nullable=true | type="integer"; nullable=true]; response200(application/json).links[].androidURL: type="string"; nullable=true; Android URL; response200(application/json).links[].iphoneURL: type="string"; nullable=true; iPhone URL; response200(application/json).links[].clicksLimit: type="integer"; minimum=1; nullable=true; disable link after specified number of clicks; response200(application/json).links[].passwordContact: type="boolean"; nullable=true; Provide your email to users to get a password; response200(application/json).links[].skipQS: type="boolean"; default=false; Skip query string merging; response200(application/json).links[].archived: type="boolean"; default=false; Link is archived; response200(application/json).links[].splitURL: type="string"; nullable=true; Split URL; response200(application/json).links[].splitPercent: type="integer"; minimum=1; maximum=100; nullable=true; Split URL percentage; response200(application/json).links[].splitURLV2: type="array"; maxItems=10; nullable=true; Split URL configurations for multi-way A/B testing; items(type="object"); response200(application/json).links[].splitURLV2[].url: required; type="string"; Split URL destination; response200(application/json).links[].splitURLV2[].percent: required; type="integer"; minimum=1; maximum=100; Traffic percentage; response200(application/json).links[].integrationAdroll: type="string"; nullable=true; Adroll integration; response200(application/json).links[].integrationFB: type="string"; nullable=true; Facebook integration; response200(application/json).links[].integrationTT: type="string"; nullable=true; TikTok integration; response200(application/json).links[].integrationGA: type="string"; nullable=true; Google Analytics integration; response200(application/json).links[].integrationGTM: type="string"; nullable=true; Google Tag Manager integration; response200(application/json).links[].languages: Destinations by visitor browser language (Accept-Language). Keys are a language (`en`) or a language and region (`en_US`, `en-us` is accepted); the most specific match wins. Replaced as a whole on update; `{}` or `null` removes every rule. Requires the Hobby plan.; anyOf=[type="object" | type="null"]; response200(application/json).links[].languages anyOf1.{key}: type="string"; response200(application/json).links[].idString: required; type="string"; Link ID; response200(application/json).links[].id: required; type="string"; Link ID; response200(application/json).links[].shortURL: required; type="string"; Short URL; response200(application/json).links[].secureShortURL: required; type="string"; Secure short URL; response200(application/json).links[].path: required; anyOf=[type="string"; Link slug. For case-insensitive domains, this is the normalized lowercase version of the path. | type="null"]; response200(application/json).links[].displayPath: required; anyOf=[type="string"; Original path preserving the case as provided during creation. Set only for case-insensitive domains when the path contains uppercase characters, otherwise null. | type="null"]; response200(application/json).links[].redirectType: type="string"; enum=["301","302","307","308"]; HTTP code for redirect; response200(application/json).links[].createdAt: required; Link creation date in ISO format; anyOf=[type="string"; format="iso-date-time" | type="null"]; response200(application/json).links[].updatedAt: required; Link last update date in ISO format; anyOf=[type="string"; format="iso-date-time" | type="null"]; response200(application/json).links[].FolderId: anyOf=[type="string"; Folder ID | type="null"]; response200(application/json).links[].DomainId: type="integer"; Domain ID; response200(application/json).links[].OwnerId: type="integer"; Owner ID; response200(application/json).links[].hasPassword: type="boolean"; default=false; Link has password; response200(application/json).links[].source: enum=["website","api","public","spreadsheets","slack","telegram",""]; Link source; response200(application/json).links[].pageType: type="integer"; enum=[1,2,3]; Special page type rendered at the short link: 1 = bundle, 2 = post, 3 = page. Absent for normal redirect links.; response200(application/json).links[].User: anyOf=[type="object" | type="null"]; response200(application/json).links[].User anyOf1.id: required; type="integer"; Creator user ID; response200(application/json).links[].User anyOf1.name: required; anyOf=[type="string"; Creator name | type="null"]; response200(application/json).links[].User anyOf1.email: required; type="string"; Creator email; response200(application/json).links[].User anyOf1.photoURL: required; anyOf=[type="string"; User photo URL | type="null"]; response200(application/json).links[].success: type="boolean"; default=true; response200(application/json).links[].duplicate: type="boolean"; default=false.

    POST /links/examples

  • Write

    Duplicate an existing link

    Duplicates an existing link with all its properties, targeting rules, and settings. The duplicated link will have a new random path (or custom if provided) and be fully independent. **Rate limit**: 50/s Request contract: path.linkId: required; Encoded link ID string of the source link; type="string"; pattern="(?:lnk|link)_\\w+_\\w+"; body(application/json): required; type="object"; body(application/json).path: type="string"; Custom path for duplicated link. Successful response contract: response200(application/json): allOf=[allOf=[allOf=[type="object" | type="object"] | type="object"] | type="object"]; response200(application/json).originalURL: required; type="string"; Original URL; response200(application/json).cloaking: type="boolean"; Cloaking; response200(application/json).password: type="string"; Link password; response200(application/json).expiresAt: Link expiration date in milliseconds or ISO string; anyOf=[type="integer"; nullable=true | type="string"; format="iso-date-time"; nullable=true]; response200(application/json).expiredURL: type="string"; nullable=true; Expired URL; response200(application/json).title: type="string"; Link title; response200(application/json).tags: type="array"; Array of link tags; items(type="string"); response200(application/json).utmSource: type="string"; set utm_source parameter to destination link; response200(application/json).utmMedium: type="string"; set utm_medium parameter to destination link; response200(application/json).utmCampaign: type="string"; set utm_campaign parameter to destination link; response200(application/json).utmTerm: type="string"; set utm_term parameter to destination link; response200(application/json).utmContent: type="string"; set utm_content parameter to destination link; response200(application/json).ttl: Time to live in milliseconds or ISO string; anyOf=[type="string"; format="iso-date-time"; nullable=true | type="integer"; nullable=true]; response200(application/json).androidURL: type="string"; nullable=true; Android URL; response200(application/json).iphoneURL: type="string"; nullable=true; iPhone URL; response200(application/json).clicksLimit: type="integer"; minimum=1; nullable=true; disable link after specified number of clicks; response200(application/json).passwordContact: type="boolean"; nullable=true; Provide your email to users to get a password; response200(application/json).skipQS: type="boolean"; default=false; Skip query string merging; response200(application/json).archived: type="boolean"; default=false; Link is archived; response200(application/json).splitURL: type="string"; nullable=true; Split URL; response200(application/json).splitPercent: type="integer"; minimum=1; maximum=100; nullable=true; Split URL percentage; response200(application/json).splitURLV2: type="array"; maxItems=10; nullable=true; Split URL configurations for multi-way A/B testing; items(type="object"); response200(application/json).splitURLV2[].url: required; type="string"; Split URL destination; response200(application/json).splitURLV2[].percent: required; type="integer"; minimum=1; maximum=100; Traffic percentage; response200(application/json).integrationAdroll: type="string"; nullable=true; Adroll integration; response200(application/json).integrationFB: type="string"; nullable=true; Facebook integration; response200(application/json).integrationTT: type="string"; nullable=true; TikTok integration; response200(application/json).integrationGA: type="string"; nullable=true; Google Analytics integration; response200(application/json).integrationGTM: type="string"; nullable=true; Google Tag Manager integration; response200(application/json).languages: Destinations by visitor browser language (Accept-Language). Keys are a language (`en`) or a language and region (`en_US`, `en-us` is accepted); the most specific match wins. Replaced as a whole on update; `{}` or `null` removes every rule. Requires the Hobby plan.; anyOf=[type="object" | type="null"]; response200(application/json).languages anyOf1.{key}: type="string"; response200(application/json).idString: required; type="string"; Link ID; response200(application/json).id: required; type="string"; Link ID; response200(application/json).shortURL: required; type="string"; Short URL; response200(application/json).secureShortURL: required; type="string"; Secure short URL; response200(application/json).path: required; anyOf=[type="string"; Link slug. For case-insensitive domains, this is the normalized lowercase version of the path. | type="null"]; response200(application/json).displayPath: required; anyOf=[type="string"; Original path preserving the case as provided during creation. Set only for case-insensitive domains when the path contains uppercase characters, otherwise null. | type="null"]; response200(application/json).redirectType: type="string"; enum=["301","302","307","308"]; HTTP code for redirect; response200(application/json).createdAt: required; Link creation date in ISO format; anyOf=[type="string"; format="iso-date-time" | type="null"]; response200(application/json).updatedAt: required; Link last update date in ISO format; anyOf=[type="string"; format="iso-date-time" | type="null"]; response200(application/json).FolderId: anyOf=[type="string"; Folder ID | type="null"]; response200(application/json).DomainId: type="integer"; Domain ID; response200(application/json).OwnerId: type="integer"; Owner ID; response200(application/json).hasPassword: type="boolean"; default=false; Link has password; response200(application/json).source: enum=["website","api","public","spreadsheets","slack","telegram",""]; Link source; response200(application/json).pageType: type="integer"; enum=[1,2,3]; Special page type rendered at the short link: 1 = bundle, 2 = post, 3 = page. Absent for normal redirect links.; response200(application/json).User: anyOf=[type="object" | type="null"]; response200(application/json).User anyOf1.id: required; type="integer"; Creator user ID; response200(application/json).User anyOf1.name: required; anyOf=[type="string"; Creator name | type="null"]; response200(application/json).User anyOf1.email: required; type="string"; Creator email; response200(application/json).User anyOf1.photoURL: required; anyOf=[type="string"; User photo URL | type="null"]; response200(application/json).success: type="boolean"; default=true; response200(application/json).duplicate: type="boolean"; default=false; response200(application/json).duplicatedFrom: required; type="string"; Original link's idString.

    POST /links/duplicate/{linkId}

  • Write

    Create a new link using public API key

    This method creates a new link. Only this method should be used in client-side applications If parameter "path" is omitted, it generates path by algorithm, chosen in domain settings. You can use it with public API key in your frontend applications (client-side javascript, Android & iPhone apps) **Rate limit**: 50/s Request contract: header.type: ; Source schema is non-object: object; header.description: ; Source schema is non-object: Request headers (must include Authorization with public API key); header.additionalProperties: ; type="string"; body(application/json): required; type="object"; body(application/json).originalURL: required; type="string"; Original URL; body(application/json).cloaking: type="boolean"; Cloaking; body(application/json).password: type="string"; Link password; body(application/json).redirectType: type="integer"; enum=[301,302,307,308]; nullable=true; HTTP code for redirect; body(application/json).expiresAt: Link expiration date in milliseconds or ISO string; anyOf=[type="integer"; nullable=true | type="string"; format="iso-date-time"; nullable=true]; body(application/json).expiredURL: type="string"; nullable=true; Expired URL; body(application/json).title: type="string"; Link title; body(application/json).tags: type="array"; Array of link tags; items(type="string"); body(application/json).utmSource: type="string"; set utm_source parameter to destination link; body(application/json).utmMedium: type="string"; set utm_medium parameter to destination link; body(application/json).utmCampaign: type="string"; set utm_campaign parameter to destination link; body(application/json).utmTerm: type="string"; set utm_term parameter to destination link; body(application/json).utmContent: type="string"; set utm_content parameter to destination link; body(application/json).ttl: Time to live in milliseconds or ISO string; anyOf=[type="string"; format="iso-date-time"; nullable=true | type="integer"; nullable=true]; body(application/json).path: type="string"; nullable=true; Link slug. For case-insensitive domains, the path is normalized to lowercase and the original value is preserved in displayPath.; body(application/json).androidURL: type="string"; nullable=true; Android URL; body(application/json).iphoneURL: type="string"; nullable=true; iPhone URL; body(application/json).createdAt: Link creation date in milliseconds; anyOf=[type="integer"; nullable=true | type="string"; format="iso-date-time"; nullable=true]; body(application/json).clicksLimit: type="integer"; minimum=1; nullable=true; disable link after specified number of clicks; body(application/json).passwordContact: type="boolean"; nullable=true; Provide your email to users to get a password; body(application/json).skipQS: type="boolean"; default=false; Skip query string merging; body(application/json).archived: type="boolean"; default=false; Link is archived; body(application/json).splitURL: type="string"; nullable=true; Split URL; body(application/json).splitPercent: type="integer"; minimum=1; maximum=100; nullable=true; Split URL percentage; body(application/json).splitURLV2: type="array"; maxItems=10; nullable=true; Split URL configurations for multi-way A/B testing; items(type="object"); body(application/json).splitURLV2[].percent: required; type="integer"; minimum=1; maximum=100; Traffic percentage; body(application/json).integrationAdroll: type="string"; nullable=true; Adroll integration; body(application/json).integrationFB: type="string"; nullable=true; Facebook integration; body(application/json).integrationTT: type="string"; nullable=true; TikTok integration; body(application/json).integrationGA: type="string"; nullable=true; Google Analytics integration; body(application/json).integrationGTM: type="string"; nullable=true; Google Tag Manager integration; body(application/json).languages: Destinations by visitor browser language (Accept-Language). Keys are a language (`en`) or a language and region (`en_US`, `en-us` is accepted); the most specific match wins. Replaced as a whole on update; `{}` or `null` removes every rule. Requires the Hobby plan.; anyOf=[type="object" | type="null"]; body(application/json).languages anyOf1.{key}: type="string"; body(application/json).domain: required; type="string"; format="hostname"; Domain hostname; body(application/json).folderId: type="string"; Folder ID to place the link into. Successful response contract: response200(application/json): allOf=[allOf=[type="object" | type="object"] | type="object"]; response200(application/json).originalURL: required; type="string"; Original URL; response200(application/json).cloaking: type="boolean"; Cloaking; response200(application/json).password: type="string"; Link password; response200(application/json).expiresAt: Link expiration date in milliseconds or ISO string; anyOf=[type="integer"; nullable=true | type="string"; format="iso-date-time"; nullable=true]; response200(application/json).expiredURL: type="string"; nullable=true; Expired URL; response200(application/json).title: type="string"; Link title; response200(application/json).tags: type="array"; Array of link tags; items(type="string"); response200(application/json).utmSource: type="string"; set utm_source parameter to destination link; response200(application/json).utmMedium: type="string"; set utm_medium parameter to destination link; response200(application/json).utmCampaign: type="string"; set utm_campaign parameter to destination link; response200(application/json).utmTerm: type="string"; set utm_term parameter to destination link; response200(application/json).utmContent: type="string"; set utm_content parameter to destination link; response200(application/json).ttl: Time to live in milliseconds or ISO string; anyOf=[type="string"; format="iso-date-time"; nullable=true | type="integer"; nullable=true]; response200(application/json).androidURL: type="string"; nullable=true; Android URL; response200(application/json).iphoneURL: type="string"; nullable=true; iPhone URL; response200(application/json).clicksLimit: type="integer"; minimum=1; nullable=true; disable link after specified number of clicks; response200(application/json).passwordContact: type="boolean"; nullable=true; Provide your email to users to get a password; response200(application/json).skipQS: type="boolean"; default=false; Skip query string merging; response200(application/json).archived: type="boolean"; default=false; Link is archived; response200(application/json).splitURL: type="string"; nullable=true; Split URL; response200(application/json).splitPercent: type="integer"; minimum=1; maximum=100; nullable=true; Split URL percentage; response200(application/json).splitURLV2: type="array"; maxItems=10; nullable=true; Split URL configurations for multi-way A/B testing; items(type="object"); response200(application/json).splitURLV2[].url: required; type="string"; Split URL destination; response200(application/json).splitURLV2[].percent: required; type="integer"; minimum=1; maximum=100; Traffic percentage; response200(application/json).integrationAdroll: type="string"; nullable=true; Adroll integration; response200(application/json).integrationFB: type="string"; nullable=true; Facebook integration; response200(application/json).integrationTT: type="string"; nullable=true; TikTok integration; response200(application/json).integrationGA: type="string"; nullable=true; Google Analytics integration; response200(application/json).integrationGTM: type="string"; nullable=true; Google Tag Manager integration; response200(application/json).languages: Destinations by visitor browser language (Accept-Language). Keys are a language (`en`) or a language and region (`en_US`, `en-us` is accepted); the most specific match wins. Replaced as a whole on update; `{}` or `null` removes every rule. Requires the Hobby plan.; anyOf=[type="object" | type="null"]; response200(application/json).languages anyOf1.{key}: type="string"; response200(application/json).idString: required; type="string"; Link ID; response200(application/json).id: required; type="string"; Link ID; response200(application/json).shortURL: required; type="string"; Short URL; response200(application/json).secureShortURL: required; type="string"; Secure short URL; response200(application/json).path: required; anyOf=[type="string"; Link slug. For case-insensitive domains, this is the normalized lowercase version of the path. | type="null"]; response200(application/json).displayPath: required; anyOf=[type="string"; Original path preserving the case as provided during creation. Set only for case-insensitive domains when the path contains uppercase characters, otherwise null. | type="null"]; response200(application/json).redirectType: type="string"; enum=["301","302","307","308"]; HTTP code for redirect; response200(application/json).createdAt: required; Link creation date in ISO format; anyOf=[type="string"; format="iso-date-time" | type="null"]; response200(application/json).updatedAt: required; Link last update date in ISO format; anyOf=[type="string"; format="iso-date-time" | type="null"]; response200(application/json).FolderId: anyOf=[type="string"; Folder ID | type="null"]; response200(application/json).DomainId: type="integer"; Domain ID; response200(application/json).OwnerId: type="integer"; Owner ID; response200(application/json).hasPassword: type="boolean"; default=false; Link has password; response200(application/json).source: enum=["website","api","public","spreadsheets","slack","telegram",""]; Link source; response200(application/json).pageType: type="integer"; enum=[1,2,3]; Special page type rendered at the short link: 1 = bundle, 2 = post, 3 = page. Absent for normal redirect links.; response200(application/json).User: anyOf=[type="object" | type="null"]; response200(application/json).User anyOf1.id: required; type="integer"; Creator user ID; response200(application/json).User anyOf1.name: required; anyOf=[type="string"; Creator name | type="null"]; response200(application/json).User anyOf1.email: required; type="string"; Creator email; response200(application/json).User anyOf1.photoURL: required; anyOf=[type="string"; User photo URL | type="null"]; response200(application/json).success: type="boolean"; default=true; response200(application/json).duplicate: type="boolean"; default=false.

    POST /links/public

  • Write

    Append a single tag to the links in bulk

    Request contract: body(application/json): required; type="object"; body(application/json).tag: required; type="string"; Tag to append to each link; body(application/json).link_ids: required; type="array"; Link id strings to tag; items(type="string"; pattern="(?:lnk|link)_[0-9a-zA-Z]+_[0-9a-zA-Z]+"; Link ID).

    POST /tags/bulk

  • Destructive

    Delete link permissions

    Request contract: path.domainId: required; Domain ID the link belongs to; type="integer"; minimum=1; path.linkId: required; Numeric link ID or encoded link ID string; type="string"; path.userId: required; User ID whose permission is being revoked; type="string". Successful response contract: response201(application/json): type="object"; response201(application/json).success: required; type="boolean"; Whether the permission was removed.

    DELETE /links/permissions/{domainId}/{linkId}/{userId}

  • Destructive

    Revoke a hosted QR code

    Request contract: path.id: required; Hosted QR code ID; type="string"; format="uuid".

    DELETE /links/qr/hosted/{id}

  • Destructive

    Delete links in bulk

    Delete links in bulk by ids **Rate limit**: 1/s Request contract: body(application/json): required; type="object"; body(application/json).link_ids: required; type="array"; minItems=1; maxItems=150; Encoded link IDs to delete; items(type="string"; pattern="(?:lnk|link)_[0-9a-zA-Z]+_[0-9a-zA-Z]+"; Link ID). Successful response contract: response200(application/json): type="object"; response200(application/json).success: required; type="boolean"; Whether the operation succeeded; response200(application/json).error: type="string"; Error message when operation failed.

    DELETE /links/delete_bulk

  • Destructive

    Archive link

    Request contract: body(application/json): required; type="object"; body(application/json).link_id: required; type="string"; Numeric link ID or encoded link ID string; body(application/json).domain_id: type="string"; Domain ID, required only when using a legacy numeric link ID. Successful response contract: response200(application/json): type="object"; response200(application/json).success: required; type="boolean"; Whether the operation succeeded; response200(application/json).error: type="string"; Error message when operation failed.

    POST /links/archive

  • Destructive

    Archive links in bulk

    Request contract: body(application/json): required; type="object"; body(application/json).link_ids: required; type="array"; maxItems=150; Link IDs to operate on; items(type="string"; Numeric link ID or encoded link ID string); body(application/json).domain_id: type="string"; Domain ID, required only when using legacy numeric link IDs. Successful response contract: response200(application/json): type="object"; response200(application/json).success: required; type="boolean"; Whether the operation succeeded; response200(application/json).error: type="string"; Error message when operation failed.

    POST /links/archive_bulk

  • Destructive

    Update existing URL

    Update original url, title or path for existing URL by id **Rate limit**: 20/s Request contract: query.domain_id: Domain ID, required only when using a legacy numeric link ID; type="string"; path.linkId: required; Numeric link ID or encoded link ID string; type="string"; pattern="(?:lnk|link)_\\w+|\\d+"; body(application/json): required; type="object"; body(application/json).cloaking: type="boolean"; Cloaking; body(application/json).password: type="string"; Link password; body(application/json).redirectType: type="integer"; enum=[301,302,307,308]; nullable=true; HTTP code for redirect; body(application/json).expiresAt: Link expiration date in milliseconds or ISO string; anyOf=[type="integer"; nullable=true | type="string"; format="iso-date-time"; nullable=true]; body(application/json).expiredURL: type="string"; nullable=true; Expired URL; body(application/json).title: type="string"; Link title; body(application/json).tags: type="array"; Array of link tags; items(type="string"); body(application/json).utmSource: type="string"; set utm_source parameter to destination link; body(application/json).utmMedium: type="string"; set utm_medium parameter to destination link; body(application/json).utmCampaign: type="string"; set utm_campaign parameter to destination link; body(application/json).utmTerm: type="string"; set utm_term parameter to destination link; body(application/json).utmContent: type="string"; set utm_content parameter to destination link; body(application/json).ttl: Time to live in milliseconds or ISO string; anyOf=[type="string"; format="iso-date-time"; nullable=true | type="integer"; nullable=true]; body(application/json).path: type="string"; nullable=true; Link slug. For case-insensitive domains, the path is normalized to lowercase and the original value is preserved in displayPath.; body(application/json).androidURL: type="string"; nullable=true; Android URL; body(application/json).iphoneURL: type="string"; nullable=true; iPhone URL; body(application/json).createdAt: Link creation date in milliseconds; anyOf=[type="integer"; nullable=true | type="string"; format="iso-date-time"; nullable=true]; body(application/json).clicksLimit: type="integer"; minimum=1; nullable=true; disable link after specified number of clicks; body(application/json).passwordContact: type="boolean"; nullable=true; Provide your email to users to get a password; body(application/json).skipQS: type="boolean"; Skip query string merging; body(application/json).archived: type="boolean"; Link is archived; body(application/json).splitURL: type="string"; nullable=true; Split URL; body(application/json).splitPercent: type="integer"; minimum=1; maximum=100; nullable=true; Split URL percentage; body(application/json).splitURLV2: type="array"; maxItems=10; nullable=true; Split URL configurations for multi-way A/B testing; items(type="object"); body(application/json).splitURLV2[].percent: required; type="integer"; minimum=1; maximum=100; Traffic percentage; body(application/json).integrationAdroll: type="string"; nullable=true; Adroll integration; body(application/json).integrationFB: type="string"; nullable=true; Facebook integration; body(application/json).integrationTT: type="string"; nullable=true; TikTok integration; body(application/json).integrationGA: type="string"; nullable=true; Google Analytics integration; body(application/json).integrationGTM: type="string"; nullable=true; Google Tag Manager integration; body(application/json).languages: Destinations by visitor browser language (Accept-Language). Keys are a language (`en`) or a language and region (`en_US`, `en-us` is accepted); the most specific match wins. Replaced as a whole on update; `{}` or `null` removes every rule. Requires the Hobby plan.; anyOf=[type="object" | type="null"]; body(application/json).languages anyOf1.{key}: type="string"; body(application/json).originalURL: type="string"; Original URL. Successful response contract: response200(application/json): allOf=[type="object" | type="object"]; response200(application/json).originalURL: required; type="string"; Original URL; response200(application/json).cloaking: type="boolean"; Cloaking; response200(application/json).password: type="string"; Link password; response200(application/json).expiresAt: Link expiration date in milliseconds or ISO string; anyOf=[type="integer"; nullable=true | type="string"; format="iso-date-time"; nullable=true]; response200(application/json).expiredURL: type="string"; nullable=true; Expired URL; response200(application/json).title: type="string"; Link title; response200(application/json).tags: type="array"; Array of link tags; items(type="string"); response200(application/json).utmSource: type="string"; set utm_source parameter to destination link; response200(application/json).utmMedium: type="string"; set utm_medium parameter to destination link; response200(application/json).utmCampaign: type="string"; set utm_campaign parameter to destination link; response200(application/json).utmTerm: type="string"; set utm_term parameter to destination link; response200(application/json).utmContent: type="string"; set utm_content parameter to destination link; response200(application/json).ttl: Time to live in milliseconds or ISO string; anyOf=[type="string"; format="iso-date-time"; nullable=true | type="integer"; nullable=true]; response200(application/json).androidURL: type="string"; nullable=true; Android URL; response200(application/json).iphoneURL: type="string"; nullable=true; iPhone URL; response200(application/json).clicksLimit: type="integer"; minimum=1; nullable=true; disable link after specified number of clicks; response200(application/json).passwordContact: type="boolean"; nullable=true; Provide your email to users to get a password; response200(application/json).skipQS: type="boolean"; default=false; Skip query string merging; response200(application/json).archived: type="boolean"; default=false; Link is archived; response200(application/json).splitURL: type="string"; nullable=true; Split URL; response200(application/json).splitPercent: type="integer"; minimum=1; maximum=100; nullable=true; Split URL percentage; response200(application/json).splitURLV2: type="array"; maxItems=10; nullable=true; Split URL configurations for multi-way A/B testing; items(type="object"); response200(application/json).splitURLV2[].url: required; type="string"; Split URL destination; response200(application/json).splitURLV2[].percent: required; type="integer"; minimum=1; maximum=100; Traffic percentage; response200(application/json).integrationAdroll: type="string"; nullable=true; Adroll integration; response200(application/json).integrationFB: type="string"; nullable=true; Facebook integration; response200(application/json).integrationTT: type="string"; nullable=true; TikTok integration; response200(application/json).integrationGA: type="string"; nullable=true; Google Analytics integration; response200(application/json).integrationGTM: type="string"; nullable=true; Google Tag Manager integration; response200(application/json).languages: Destinations by visitor browser language (Accept-Language). Keys are a language (`en`) or a language and region (`en_US`, `en-us` is accepted); the most specific match wins. Replaced as a whole on update; `{}` or `null` removes every rule. Requires the Hobby plan.; anyOf=[type="object" | type="null"]; response200(application/json).languages anyOf1.{key}: type="string"; response200(application/json).idString: required; type="string"; Link ID; response200(application/json).id: required; type="string"; Link ID; response200(application/json).shortURL: required; type="string"; Short URL; response200(application/json).secureShortURL: required; type="string"; Secure short URL; response200(application/json).path: required; anyOf=[type="string"; Link slug. For case-insensitive domains, this is the normalized lowercase version of the path. | type="null"]; response200(application/json).displayPath: required; anyOf=[type="string"; Original path preserving the case as provided during creation. Set only for case-insensitive domains when the path contains uppercase characters, otherwise null. | type="null"]; response200(application/json).redirectType: type="string"; enum=["301","302","307","308"]; HTTP code for redirect; response200(application/json).createdAt: required; Link creation date in ISO format; anyOf=[type="string"; format="iso-date-time" | type="null"]; response200(application/json).updatedAt: required; Link last update date in ISO format; anyOf=[type="string"; format="iso-date-time" | type="null"]; response200(application/json).FolderId: anyOf=[type="string"; Folder ID | type="null"]; response200(application/json).DomainId: type="integer"; Domain ID; response200(application/json).OwnerId: type="integer"; Owner ID; response200(application/json).hasPassword: type="boolean"; default=false; Link has password; response200(application/json).source: enum=["website","api","public","spreadsheets","slack","telegram",""]; Link source; response200(application/json).pageType: type="integer"; enum=[1,2,3]; Special page type rendered at the short link: 1 = bundle, 2 = post, 3 = page. Absent for normal redirect links.; response200(application/json).User: anyOf=[type="object" | type="null"]; response200(application/json).User anyOf1.id: required; type="integer"; Creator user ID; response200(application/json).User anyOf1.name: required; anyOf=[type="string"; Creator name | type="null"]; response200(application/json).User anyOf1.email: required; type="string"; Creator email; response200(application/json).User anyOf1.photoURL: required; anyOf=[type="string"; User photo URL | type="null"].

    POST /links/{linkId}

Link Targeting

  • Write

    Create link country

    Request contract: query.domainId: Domain ID, required only when using a legacy numeric link ID; type="string"; path.linkId: required; Numeric link ID or encoded link ID string; type="string"; body(application/json): required; type="object"; body(application/json).country: required; enum=["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW","EU","QF","QS","QE","QO","QN","QT","XK"]; Country code; body(application/json).originalURL: required; type="string"; format="uri"; Destination URL for visitors from this country.

    POST /link_country/{linkId}

  • Write

    Create link countries in bulk

    Request contract: query.domainId: Domain ID, required only when using a legacy numeric link ID; type="string"; path.linkId: required; Numeric link ID or encoded link ID string; type="string"; body(application/json): required; type="array"; maxItems=500; List of country-specific redirect rules to create; items(type="object"; Country-specific redirect rule); body(application/json)[].country: required; enum=["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW","EU","QF","QS","QE","QO","QN","QT","XK"]; Country code; body(application/json)[].originalURL: required; type="string"; Destination URL for visitors from this country.

    POST /link_country/bulk/{linkId}

  • Write

    Add region targeting to link

    Add region targeting to link Request contract: query.domainId: Domain ID; type="integer"; minimum=1; path.linkId: required; Numeric link ID or encoded link ID string; type="string"; body(application/json): required; type="object"; body(application/json).country: required; enum=["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW","EU","QF","QS","QE","QO","QN","QT","XK"]; Country code; body(application/json).region: required; type="string"; ISO 3166-2 region code; body(application/json).originalURL: required; type="string"; Destination URL for visitors from this region.

    POST /link_region/{linkId}

  • Write

    Create link regions in bulk

    Request contract: query.domainId: Domain ID, required only when using a legacy numeric link ID; type="integer"; path.linkId: required; Numeric link ID or encoded link ID string; type="string"; body(application/json): required; type="array"; List of region-specific redirect rules to create; items(type="object"; Region-specific redirect rule); body(application/json)[].country: required; enum=["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW","EU","QF","QS","QE","QO","QN","QT","XK"]; Country code; body(application/json)[].region: required; type="string"; ISO 3166-2 region code; body(application/json)[].originalURL: required; type="string"; Destination URL for visitors from this region.

    POST /link_region/bulk/{linkId}

QR Codes

  • Read

    Get link QR code settings

    Returns the QR code settings saved for the link, applied on every generation instead of the domain or folder settings. Request contract: path.linkIdString: required; Link ID; type="string"; pattern="(?:lnk|link)_[0-9a-zA-Z]+_[0-9a-zA-Z]+".

    GET /links/qr/settings/{linkIdString}

  • Read

    Get domain QR code settings

    Returns the default QR code settings applied to the domain's links. Request contract: path.domainId: required; Domain ID; type="number".

    GET /domains/qrCodeSettings/{domainId}

  • Write

    Create or update link QR code settings

    Saves the QR code settings for the link. Omitted fields are left untouched; send an empty string to clear a text field. Request contract: path.linkIdString: required; Link ID; type="string"; pattern="(?:lnk|link)_[0-9a-zA-Z]+_[0-9a-zA-Z]+"; body(application/json): required; type="object"; body(application/json).logoUrl: type="string"; maxLength=255; URL of the logo image embedded in the QR code; body(application/json).color: type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA); body(application/json).backgroundColor: type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA); body(application/json).logoHeight: type="integer"; minimum=1; Logo height in pixels; body(application/json).logoWidth: type="integer"; minimum=1; Logo width in pixels; body(application/json).ecLevel: enum=["L","M","Q","H"]; QR code error correction level; body(application/json).borderRadius: type="integer"; minimum=0; maximum=5; Dot border radius on the dashboard 0-5 scale, 5 = fully round; body(application/json).noExcavate: type="boolean"; Disable logo excavation (cutout) in the QR code; body(application/json).finderOuterShape: enum=["square","rounded","circle","drop"]; Shape of the outer finder pattern; body(application/json).finderInnerShape: enum=["square","rounded","circle","drop"]; Shape of the inner finder pattern; body(application/json).finderColor: type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA); body(application/json).cornerMode: enum=["individual","merge"]; Corner module rendering mode; body(application/json).labelText: type="string"; maxLength=255; Optional text label rendered with the QR code; body(application/json).labelStyle: enum=["below","pill","box"]; Label visual style; body(application/json).labelColor: type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA); body(application/json).labelBgColor: type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA); body(application/json).labelFontSize: type="integer"; minimum=1; maximum=20; Label font size in module units (rendered px = value * block size); body(application/json).labelFontFamily: type="string"; maxLength=255; Label font family name.

    POST /links/qr/settings/{linkIdString}

  • Write

    Upload link QR code logo

    Uploads the logo embedded in the link's QR code, as the raw image body. Save the returned URL as logoUrl in the link's QR code settings. Request contract: path.linkIdString: required; Link ID; type="string"; pattern="(?:lnk|link)_[0-9a-zA-Z]+_[0-9a-zA-Z]+"; body(application/json): required; object/union schema.

    PUT /links/qr/settings/logo/{linkIdString}

  • Write

    Create or update domain QR code settings

    Creates or updates the default QR code settings applied to the domain's links. Request contract: path.domainId: required; Domain ID; type="number"; body(application/json): required; type="object"; body(application/json).color: type="string"; pattern="^[0-9a-fA-F]{6,8}$"; QR code foreground color as hex (RRGGBB or RRGGBBAA); body(application/json).backgroundColor: type="string"; pattern="^[0-9a-fA-F]{6,8}$"; QR code background color as hex; body(application/json).logoUrl: type="string"; URL of the logo image embedded in the QR code; body(application/json).logoHeight: type="number"; Logo height in pixels; body(application/json).logoWidth: type="number"; Logo width in pixels; body(application/json).ecLevel: enum=["L","M","Q","H"]; QR code error correction level; body(application/json).borderRadius: type="number"; Module border radius in pixels; body(application/json).noExcavate: type="boolean"; Disable logo area excavation; body(application/json).finderOuterShape: enum=["square","rounded","circle","drop"]; Shape of the outer finder pattern; body(application/json).finderInnerShape: enum=["square","rounded","circle","drop"]; Shape of the inner finder pattern; body(application/json).finderColor: type="string"; pattern="^[0-9a-fA-F]{6,8}$"; Finder pattern color as hex; body(application/json).cornerMode: enum=["individual","merge"]; Corner module rendering mode; body(application/json).labelText: type="string"; Optional text label rendered with the QR code; body(application/json).labelStyle: enum=["below","pill","box"]; Label visual style; body(application/json).labelColor: type="string"; pattern="^[0-9a-fA-F]{6,8}$"; Label text color as hex; body(application/json).labelBgColor: type="string"; pattern="^[0-9a-fA-F]{6,8}$"; Label background color as hex; body(application/json).labelFontSize: type="number"; Label font size in pixels; body(application/json).labelFontFamily: type="string"; Label font family name.

    POST /domains/qrCodeSettings/{domainId}

  • Write

    Upload QR code logo

    Uploads the logo embedded in the domain's QR codes, as multipart form data. Request contract: path.domainId: required; Domain ID; type="number"; body(application/json): required; object/union schema.

    PUT /domains/qrCodeSettings/logo/{domainId}

  • Destructive

    Delete link QR code settings

    Deletes the QR code settings saved for the link, reverting to the domain or folder settings. Request contract: path.linkIdString: required; Link ID; type="string"; pattern="(?:lnk|link)_[0-9a-zA-Z]+_[0-9a-zA-Z]+".

    DELETE /links/qr/settings/{linkIdString}

  • Destructive

    Delete domain QR code settings

    Deletes the domain's QR code settings, reverting to defaults. Request contract: path.domainId: required; Domain ID; type="number".

    DELETE /domains/qrCodeSettings/{domainId}

Domains

  • Read

    List domains

    Shows all domains of current user Request contract: query.limit: Maximum number of domains to return; type="integer"; default=100; minimum=1; maximum=300; query.offset: Number of domains to skip for pagination; type="integer"; default=0; minimum=0; query.noTeamId: Return only personal domains not assigned to a team; type="boolean"; query.pattern: Hostname substring filter; type="string"; query.teamId: Filter domains by team ID; type="number"; header.type: ; Source schema is non-object: object; header.additionalProperties: ; type="string". Successful response contract: response200(application/json): type="array"; items(type="object"); response200(application/json)[].id: required; type="integer"; minimum=1; Domain ID; response200(application/json)[].hostname: required; type="string"; format="hostname"; response200(application/json)[].unicodeHostname: required; type="string"; format="fqdn"; response200(application/json)[].state: required; enum=["extra_records","not_registered","configured","not_configured","registration_pending","not_verified"]; response200(application/json)[].createdAt: required; type="string"; format="date-time"; response200(application/json)[].updatedAt: required; type="string"; format="date-time"; response200(application/json)[].TeamId: anyOf=[type="integer" | type="null"]; response200(application/json)[].OrganizationId: anyOf=[type="string"; format="uuid" | type="null"]; response200(application/json)[].hasFavicon: required; type="boolean"; response200(application/json)[].faviconURL: required; anyOf=[type="string"; format="uri" | type="null"]; response200(application/json)[].segmentKey: anyOf=[type="string" | type="null"]; response200(application/json)[].posthogProjectApiKey: anyOf=[type="string" | type="null"]; response200(application/json)[].posthogHost: anyOf=[type="string"; format="iri" | type="null"]; response200(application/json)[].hideReferer: required; type="boolean"; response200(application/json)[].linkType: required; enum=["increment","random","secure","four-char","eight-char","ten-char"]; response200(application/json)[].cloaking: required; type="boolean"; Enable cloaking for all links on the domain; response200(application/json)[].hideVisitorIp: required; type="boolean"; Don't store visitor IPs in our database; response200(application/json)[].enableAI: required; type="boolean"; Enable AI for all links on the domain; response200(application/json)[].httpsLevel: required; enum=["none","redirect","hsts"]; response200(application/json)[].hstsMaxAge: Strict-Transport-Security max-age in seconds when httpsLevel is "hsts", from one year (31536000) to two years (63072000). Null means one year.; anyOf=[type="integer" | type="null"]; response200(application/json)[].hstsIncludeSubDomains: type="boolean"; Add includeSubDomains to the Strict-Transport-Security header when httpsLevel is "hsts"; response200(application/json)[].httpsLinks: required; anyOf=[type="boolean" | type="null"]; response200(application/json)[].webhookURL: anyOf=[type="string"; format="iri" | type="null"]; response200(application/json)[].integrationGA: anyOf=[type="string" | type="null"]; response200(application/json)[].integrationFB: anyOf=[type="string" | type="null"]; response200(application/json)[].integrationTT: anyOf=[type="string" | type="null"]; response200(application/json)[].integrationAdroll: anyOf=[type="string" | type="null"]; response200(application/json)[].integrationGTM: anyOf=[type="string" | type="null"]; response200(application/json)[].clientStorage: required; anyOf=[type="object" | type="null"]; response200(application/json)[].clientStorage anyOf1.{key}: object/union schema; response200(application/json)[].caseSensitive: required; type="boolean"; response200(application/json)[].incrementCounter: required; type="string"; response200(application/json)[].robots: required; enum=["allow","disallow","noindex"]; response200(application/json)[].sslCertExpirationDate: anyOf=[type="string"; format="date-time" | type="null"]; response200(application/json)[].sslCertInstalledSuccess: anyOf=[type="boolean" | type="null"]; response200(application/json)[].domainRegistrationId: anyOf=[type="integer" | type="null"]; response200(application/json)[].registrationExpiresAt: When the registration of a domain bought through us expires, null for external domains; anyOf=[type="string"; format="date-time" | type="null"]; response200(application/json)[].registrationAutoRenew: Whether the registration renews itself before it expires, null for external domains. When true, an upcoming expiry needs no action from the customer; anyOf=[type="boolean" | type="null"]; response200(application/json)[].exportEnabled: required; type="boolean"; response200(application/json)[].enableConversionTracking: required; type="boolean"; response200(application/json)[].qrScanTracking: required; type="boolean"; default=true; response200(application/json)[].preventScraping: required; enum=["none","all"]; default="none"; "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.; response200(application/json)[].dnsConfigDeprecated: required; type="boolean"; response200(application/json)[].isFavorite: required; type="boolean"; Whether the user marked this domain as favorite.

    GET /api/domains

  • Read

    Get domain details by id

    Request contract: path.domainId: required; Domain ID; type="integer"; minimum=1. Successful response contract: response200(application/json): allOf=[type="object" | type="object"]; response200(application/json).id: required; type="integer"; minimum=1; Domain ID; response200(application/json).hostname: required; type="string"; format="hostname"; response200(application/json).unicodeHostname: required; type="string"; format="fqdn"; response200(application/json).state: required; enum=["extra_records","not_registered","configured","not_configured","registration_pending","not_verified"]; response200(application/json).createdAt: required; type="string"; format="date-time"; response200(application/json).updatedAt: required; type="string"; format="date-time"; response200(application/json).TeamId: anyOf=[type="integer" | type="null"]; response200(application/json).OrganizationId: anyOf=[type="string"; format="uuid" | type="null"]; response200(application/json).hasFavicon: required; type="boolean"; response200(application/json).faviconURL: required; anyOf=[type="string"; format="uri" | type="null"]; response200(application/json).segmentKey: anyOf=[type="string" | type="null"]; response200(application/json).posthogProjectApiKey: anyOf=[type="string" | type="null"]; response200(application/json).posthogHost: anyOf=[type="string"; format="iri" | type="null"]; response200(application/json).hideReferer: required; type="boolean"; response200(application/json).linkType: required; enum=["increment","random","secure","four-char","eight-char","ten-char"]; response200(application/json).cloaking: required; type="boolean"; Enable cloaking for all links on the domain; response200(application/json).hideVisitorIp: required; type="boolean"; Don't store visitor IPs in our database; response200(application/json).enableAI: required; type="boolean"; Enable AI for all links on the domain; response200(application/json).httpsLevel: required; enum=["none","redirect","hsts"]; response200(application/json).hstsMaxAge: Strict-Transport-Security max-age in seconds when httpsLevel is "hsts", from one year (31536000) to two years (63072000). Null means one year.; anyOf=[type="integer" | type="null"]; response200(application/json).hstsIncludeSubDomains: type="boolean"; Add includeSubDomains to the Strict-Transport-Security header when httpsLevel is "hsts"; response200(application/json).httpsLinks: required; anyOf=[type="boolean" | type="null"]; response200(application/json).webhookURL: anyOf=[type="string"; format="iri" | type="null"]; response200(application/json).integrationGA: anyOf=[type="string" | type="null"]; response200(application/json).integrationFB: anyOf=[type="string" | type="null"]; response200(application/json).integrationTT: anyOf=[type="string" | type="null"]; response200(application/json).integrationAdroll: anyOf=[type="string" | type="null"]; response200(application/json).integrationGTM: anyOf=[type="string" | type="null"]; response200(application/json).clientStorage: required; anyOf=[type="object" | type="null"]; response200(application/json).clientStorage anyOf1.{key}: object/union schema; response200(application/json).caseSensitive: required; type="boolean"; response200(application/json).incrementCounter: required; type="string"; response200(application/json).robots: required; enum=["allow","disallow","noindex"]; response200(application/json).sslCertExpirationDate: anyOf=[type="string"; format="date-time" | type="null"]; response200(application/json).sslCertInstalledSuccess: anyOf=[type="boolean" | type="null"]; response200(application/json).domainRegistrationId: anyOf=[type="integer" | type="null"]; response200(application/json).registrationExpiresAt: When the registration of a domain bought through us expires, null for external domains; anyOf=[type="string"; format="date-time" | type="null"]; response200(application/json).registrationAutoRenew: Whether the registration renews itself before it expires, null for external domains. When true, an upcoming expiry needs no action from the customer; anyOf=[type="boolean" | type="null"]; response200(application/json).exportEnabled: required; type="boolean"; response200(application/json).enableConversionTracking: required; type="boolean"; response200(application/json).qrScanTracking: required; type="boolean"; default=true; response200(application/json).preventScraping: required; enum=["none","all"]; default="none"; "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.; response200(application/json).dnsConfigDeprecated: required; type="boolean"; response200(application/json).ipExclusions: required; type="array"; IP addresses excluded from click tracking; items(type="string"; IP address excluded from click tracking); response200(application/json).userPlan: required; enum=["tiny","hobby","small","standard","large"]; Plan type of the domain owner; response200(application/json).linkSignatureKeyLast4: required; Last 4 characters of the domain's link-signature key, or null when signing is disabled. The full key is only returned when it is rotated.; anyOf=[type="string" | type="null"].

    GET /domains/{domainId}

  • Read

    List pending domain transfers

    Request contract: query.direction: incoming: offered to this organization; outgoing: offered by it; default="all"; anyOf=[type="string"; enum=["incoming"] | type="string"; enum=["outgoing"] | type="string"; enum=["all"]]. Successful response contract: response200(application/json): type="object"; response200(application/json).incoming: required; type="array"; items(type="object"); response200(application/json).incoming[].id: required; type="string"; format="uuid"; Transfer request id; response200(application/json).incoming[].hostname: required; type="string"; Hostname of the domain being transferred; response200(application/json).incoming[].domainId: required; type="integer"; response200(application/json).incoming[].status: required; enum=["pending","accepted","declined","cancelled","expired"]; response200(application/json).incoming[].createdAt: required; type="string"; format="date-time"; response200(application/json).incoming[].expiresAt: required; type="string"; format="date-time"; When the pending request expires if not accepted; response200(application/json).incoming[].sourceOrganization: required; type="object"; response200(application/json).incoming[].sourceOrganization.id: required; type="string"; format="uuid"; response200(application/json).incoming[].sourceOrganization.name: required; type="string"; response200(application/json).incoming[].targetOrganization: required; type="object"; response200(application/json).incoming[].targetOrganization.id: required; type="string"; format="uuid"; response200(application/json).incoming[].targetOrganization.name: required; type="string"; response200(application/json).incoming[].requestedBy: required; type="object"; response200(application/json).incoming[].requestedBy.id: required; type="integer"; response200(application/json).incoming[].requestedBy.name: required; type="string"; response200(application/json).incoming[].requestedBy.email: required; type="string"; response200(application/json).incoming[].registration: required; Set when the domain was purchased through short.io; its renewal billing moves with it; anyOf=[type="object" | type="null"]; response200(application/json).incoming[].registration anyOf1.renewalPrice: required; Yearly renewal price in cents the receiving organization will be billed; anyOf=[type="integer" | type="null"]; response200(application/json).incoming[].registration anyOf1.expiresAt: required; anyOf=[type="string"; format="date-time" | type="null"]; response200(application/json).incoming[].registration anyOf1.autoRenew: required; type="boolean"; response200(application/json).outgoing: required; type="array"; items(type="object"); response200(application/json).outgoing[].id: required; type="string"; format="uuid"; Transfer request id; response200(application/json).outgoing[].hostname: required; type="string"; Hostname of the domain being transferred; response200(application/json).outgoing[].domainId: required; type="integer"; response200(application/json).outgoing[].status: required; enum=["pending","accepted","declined","cancelled","expired"]; response200(application/json).outgoing[].createdAt: required; type="string"; format="date-time"; response200(application/json).outgoing[].expiresAt: required; type="string"; format="date-time"; When the pending request expires if not accepted; response200(application/json).outgoing[].sourceOrganization: required; type="object"; response200(application/json).outgoing[].sourceOrganization.id: required; type="string"; format="uuid"; response200(application/json).outgoing[].sourceOrganization.name: required; type="string"; response200(application/json).outgoing[].targetOrganization: required; type="object"; response200(application/json).outgoing[].targetOrganization.id: required; type="string"; format="uuid"; response200(application/json).outgoing[].targetOrganization.name: required; type="string"; response200(application/json).outgoing[].requestedBy: required; type="object"; response200(application/json).outgoing[].requestedBy.id: required; type="integer"; response200(application/json).outgoing[].requestedBy.name: required; type="string"; response200(application/json).outgoing[].requestedBy.email: required; type="string"; response200(application/json).outgoing[].registration: required; Set when the domain was purchased through short.io; its renewal billing moves with it; anyOf=[type="object" | type="null"]; response200(application/json).outgoing[].registration anyOf1.renewalPrice: required; Yearly renewal price in cents the receiving organization will be billed; anyOf=[type="integer" | type="null"]; response200(application/json).outgoing[].registration anyOf1.expiresAt: required; anyOf=[type="string"; format="date-time" | type="null"]; response200(application/json).outgoing[].registration anyOf1.autoRenew: required; type="boolean".

    GET /domains/transfers

  • Read

    List allowed hostnames

    Returns the domain's allowed-hostnames list. Request contract: path.domainId: required; Domain ID; type="integer"; minimum=1.

    GET /domains/allowedHostnames/{domainId}

  • Read

    Get password page CSS

    Returns the custom CSS applied to the domain's password prompt page. Request contract: path.domainId: required; Domain ID; type="integer"; minimum=1.

    GET /domains/password/{domainId}

  • Read

    Get domain theme

    Returns theme settings for the domain. Request contract: path.domainId: required; Domain ID; type="integer"; minimum=1.

    GET /domains/theme/{domainId}

  • Read

    Get universal links

    Returns the iOS/Android universal-link (app association) configuration for the domain. Request contract: path.domainId: required; Domain ID; type="integer"; minimum=1.

    GET /domains/universalLinks/{domainId}

  • Read

    Get S3 export status

    Returns the S3 click-export configuration and status for the domain. Request contract: path.domainId: required; Domain ID; type="integer"; minimum=1.

    GET /domains/s3exports/{domainId}

  • Write

    Decline a pending domain transfer

    Request contract: path.transferId: required; Transfer request id; type="string"; format="uuid". Successful response contract: response200(application/json): type="object"; response200(application/json).success: required; type="boolean"; enum=[true].

    POST /domains/transfers/{transferId}/decline

  • Write

    Cancel a pending domain transfer

    Request contract: path.transferId: required; Transfer request id; type="string"; format="uuid". Successful response contract: response200(application/json): type="object"; response200(application/json).success: required; type="boolean"; enum=[true].

    POST /domains/transfers/{transferId}/cancel

  • Write

    Add allowed hostname

    Adds a hostname to the domain's allowed-hostnames list. Request contract: path.domainId: required; Domain ID; type="integer"; minimum=1; body(application/json): required; type="object"; body(application/json).hostname: required; type="string"; minLength=1; Referrer hostname allowed to use this domain's links.

    POST /domains/allowedHostnames/{domainId}

  • Write

    Mark domain as favorite

    Marks the domain as a favorite for the current user. Request contract: path.domainId: required; Domain ID; type="integer"; minimum=1.

    POST /domains/favorite/{domainId}

  • Write

    Set password page CSS

    Sets the custom CSS applied to the domain's password prompt page. Request contract: path.domainId: required; Domain ID; type="integer"; minimum=1; body(application/json): required; type="object"; body(application/json).css: required; type="string"; CSS stylesheet for the password-protected page.

    POST /domains/password/{domainId}

  • Write

    Create or update domain theme

    Creates or updates theme settings for the domain. Colors are 6- or 8-character hex strings without the leading `#` (RRGGBB, or RRGGBBAA for transparency). Request contract: path.domainId: required; Domain ID; type="integer"; minimum=1; body(application/json): required; type="object"; body(application/json).primaryColor: anyOf=[type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA) | type="null"]; body(application/json).secondaryColor: anyOf=[type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA) | type="null"]; body(application/json).backgroundColor: anyOf=[type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA) | type="null"]; body(application/json).contentBgColor: anyOf=[type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA) | type="null"]; body(application/json).textColor: anyOf=[type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA) | type="null"]; body(application/json).headingColor: anyOf=[type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA) | type="null"]; body(application/json).linkColor: anyOf=[type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA) | type="null"]; body(application/json).buttonTextColor: anyOf=[type="string"; minLength=6; maxLength=8; pattern="^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"; 6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA) | type="null"]; body(application/json).fontFamily: CSS font-family for themed pages; anyOf=[type="string"; maxLength=255 | type="null"]; body(application/json).customProperties: Custom CSS variable key/value pairs; anyOf=[type="object" | type="null"]; body(application/json).customProperties anyOf1.{key}: type="string"; maxLength=1000.

    POST /domains/theme/{domainId}

  • Write

    Add IP exclusion

    Adds an IP address to the domain's exclusion list, so clicks from it are not counted. Request contract: path.domainId: required; Domain ID; type="integer"; minimum=1; body(application/json): required; type="object"; body(application/json).ip: required; type="string"; format="ipv4"; IPv4 address to exclude from click tracking.

    POST /domains/ipExclusions/{domainId}

  • Write

    Create or update universal links

    Creates or updates the iOS/Android universal-link (app association) configuration for the domain. Request contract: path.domainId: required; Domain ID; type="integer"; minimum=1; body(application/json): required; type="object"; body(application/json).androidAppId: type="string"; Android application package ID; body(application/json).appleAppId: type="string"; Apple app ID including team prefix; body(application/json).appleClip: type="string"; Apple App Clip bundle ID; body(application/json).iosAssetslinks: type="string"; Raw apple-app-site-association JSON content; body(application/json).androidAssetslinks: type="string"; Raw assetlinks.json content for Android; body(application/json).androidKeyFingerPrint1: type="string"; Android signing cert SHA-256 fingerprint; body(application/json).androidKeyFingerPrint2: type="string"; Additional Android signing cert SHA-256 fingerprint; body(application/json).androidKeyFingerPrint3: type="string"; Additional Android signing cert SHA-256 fingerprint.

    POST /domains/universalLinks/{domainId}

  • Write

    Enable S3 export

    Enables daily S3 click export for the domain. Request contract: path.domainId: required; Domain ID; type="integer"; minimum=1; body(application/json): required; type="object"; body(application/json).timezone: type="string"; maxLength=2048; IANA timezone used for daily export windows.

    POST /domains/s3exports/{domainId}

  • Write

    Create a domain

    Request contract: body(application/json): required; type="object"; body(application/json).hostname: required; type="string"; format="idn-hostname"; Domain hostname; body(application/json).hideReferer: type="boolean"; Strip referer header on redirect; body(application/json).linkType: enum=["increment","random","secure","four-char","eight-char","ten-char"]; Default link type for the domain; body(application/json).teamId: type="integer"; minimum=1; Team to create the domain in. Required for non-admin organization members; optional for organization admins.. Successful response contract: response200(application/json): type="object"; response200(application/json).id: required; type="integer"; minimum=1; Domain ID; response200(application/json).hostname: required; type="string"; format="hostname"; response200(application/json).unicodeHostname: required; type="string"; format="fqdn"; response200(application/json).state: required; enum=["extra_records","not_registered","configured","not_configured","registration_pending","not_verified"]; response200(application/json).createdAt: required; type="string"; format="date-time"; response200(application/json).updatedAt: required; type="string"; format="date-time"; response200(application/json).TeamId: anyOf=[type="integer" | type="null"]; response200(application/json).OrganizationId: anyOf=[type="string"; format="uuid" | type="null"]; response200(application/json).hasFavicon: required; type="boolean"; response200(application/json).faviconURL: required; anyOf=[type="string"; format="uri" | type="null"]; response200(application/json).segmentKey: anyOf=[type="string" | type="null"]; response200(application/json).posthogProjectApiKey: anyOf=[type="string" | type="null"]; response200(application/json).posthogHost: anyOf=[type="string"; format="iri" | type="null"]; response200(application/json).hideReferer: required; type="boolean"; response200(application/json).linkType: required; enum=["increment","random","secure","four-char","eight-char","ten-char"]; response200(application/json).cloaking: required; type="boolean"; Enable cloaking for all links on the domain; response200(application/json).hideVisitorIp: required; type="boolean"; Don't store visitor IPs in our database; response200(application/json).enableAI: required; type="boolean"; Enable AI for all links on the domain; response200(application/json).httpsLevel: required; enum=["none","redirect","hsts"]; response200(application/json).hstsMaxAge: Strict-Transport-Security max-age in seconds when httpsLevel is "hsts", from one year (31536000) to two years (63072000). Null means one year.; anyOf=[type="integer" | type="null"]; response200(application/json).hstsIncludeSubDomains: type="boolean"; Add includeSubDomains to the Strict-Transport-Security header when httpsLevel is "hsts"; response200(application/json).httpsLinks: required; anyOf=[type="boolean" | type="null"]; response200(application/json).webhookURL: anyOf=[type="string"; format="iri" | type="null"]; response200(application/json).integrationGA: anyOf=[type="string" | type="null"]; response200(application/json).integrationFB: anyOf=[type="string" | type="null"]; response200(application/json).integrationTT: anyOf=[type="string" | type="null"]; response200(application/json).integrationAdroll: anyOf=[type="string" | type="null"]; response200(application/json).integrationGTM: anyOf=[type="string" | type="null"]; response200(application/json).clientStorage: required; anyOf=[type="object" | type="null"]; response200(application/json).clientStorage anyOf1.{key}: object/union schema; response200(application/json).caseSensitive: required; type="boolean"; response200(application/json).incrementCounter: required; type="string"; response200(application/json).robots: required; enum=["allow","disallow","noindex"]; response200(application/json).sslCertExpirationDate: anyOf=[type="string"; format="date-time" | type="null"]; response200(application/json).sslCertInstalledSuccess: anyOf=[type="boolean" | type="null"]; response200(application/json).domainRegistrationId: anyOf=[type="integer" | type="null"]; response200(application/json).registrationExpiresAt: When the registration of a domain bought through us expires, null for external domains; anyOf=[type="string"; format="date-time" | type="null"]; response200(application/json).registrationAutoRenew: Whether the registration renews itself before it expires, null for external domains. When true, an upcoming expiry needs no action from the customer; anyOf=[type="boolean" | type="null"]; response200(application/json).exportEnabled: required; type="boolean"; response200(application/json).enableConversionTracking: required; type="boolean"; response200(application/json).qrScanTracking: required; type="boolean"; default=true; response200(application/json).preventScraping: required; enum=["none","all"]; default="none"; "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.; response200(application/json).dnsConfigDeprecated: required; type="boolean".

    POST /domains

  • Destructive

    Update domain settings

    Update domain settings Request contract: path.domainId: required; Domain ID; type="integer"; minimum=1; body(application/json): required; type="object"; body(application/json).httpsLevel: enum=["none","redirect","hsts"]; body(application/json).hstsMaxAge: Strict-Transport-Security max-age in seconds when httpsLevel is "hsts", from one year (31536000) to two years (63072000). Null means one year.; anyOf=[type="integer"; minimum=31536000; maximum=63072000 | type="null"]; body(application/json).hstsIncludeSubDomains: type="boolean"; Add includeSubDomains to the Strict-Transport-Security header when httpsLevel is "hsts"; body(application/json).robots: enum=["allow","disallow","noindex"]; body(application/json).segmentKey: type="string"; nullable=true; body(application/json).posthogProjectApiKey: type="string"; nullable=true; body(application/json).posthogHost: anyOf=[type="string"; pattern="^https://([a-z0-9-]+\\.)*posthog\\.com/?$"; Origin of an official PostHog Cloud instance, e.g. https://eu.i.posthog.com | type="string"; enum=[""] | type="null"]; body(application/json).linkType: enum=["increment","random","secure","four-char","eight-char","ten-char"]; body(application/json).cloaking: type="boolean"; Enable cloaking for all links on the domain; body(application/json).hideReferer: type="boolean"; body(application/json).hideVisitorIp: type="boolean"; Don't store visitor IPs in our database; body(application/json).httpsLinks: type="boolean"; nullable=true; Set to null to reissue a certificate; body(application/json).webhookURL: anyOf=[type="string"; format="iri" | type="string"; enum=[""] | type="null"]; body(application/json).integrationGA: type="string"; nullable=true; body(application/json).integrationFB: type="string"; nullable=true; body(application/json).integrationTT: type="string"; nullable=true; body(application/json).integrationAdroll: type="string"; nullable=true; body(application/json).enableConversionTracking: type="boolean"; body(application/json).qrScanTracking: type="boolean"; default=true; body(application/json).preventScraping: enum=["none","all"]; "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.; body(application/json).integrationGTM: type="string"; pattern="^$|G(TM)?-\\w+"; nullable=true; body(application/json).clientStorage: type="object"; For internal use; body(application/json).clientStorage.{key}: object/union schema; body(application/json).purgeExpiredLinks: type="boolean"; [DEPRECATED] do not use; body(application/json).enableAI: type="boolean"; body(application/json).caseSensitive: type="boolean"; Enable case sensitivity for short links. Successful response contract: response200(application/json): type="object"; response200(application/json).success: required; type="boolean"; Whether the operation succeeded.

    POST /domains/settings/{domainId}

  • Destructive

    Rotate the domain link-signature key

    Generates a new per-domain HMAC secret used by the redirector to sign redirect destination URLs, and returns it. Regenerating invalidates the previous key. Request contract: path.domainId: required; Domain ID; type="integer"; minimum=1. Successful response contract: response200(application/json): type="object"; response200(application/json).linkSignatureKey: required; type="string"; Newly generated per-domain HMAC secret used to sign redirect URLs (si_sig).

    POST /domains/link-signature-key/{domainId}

  • Destructive

    Transfer a domain to another organization

    Request contract: path.domainId: required; Domain ID to transfer; type="integer"; minimum=1; body(application/json): required; type="object"; body(application/json).targetOrganizationId: required; type="string"; Target organization id. Successful response contract: response200(application/json): type="object"; response200(application/json).success: required; type="boolean"; enum=[true]; response200(application/json).transfer: type="object"; response200(application/json).transfer.id: required; type="string"; format="uuid"; Transfer request id; response200(application/json).transfer.hostname: required; type="string"; Hostname of the domain being transferred; response200(application/json).transfer.domainId: required; type="integer"; response200(application/json).transfer.status: required; enum=["pending","accepted","declined","cancelled","expired"]; response200(application/json).transfer.createdAt: required; type="string"; format="date-time"; response200(application/json).transfer.expiresAt: required; type="string"; format="date-time"; When the pending request expires if not accepted; response200(application/json).transfer.sourceOrganization: required; type="object"; response200(application/json).transfer.sourceOrganization.id: required; type="string"; format="uuid"; response200(application/json).transfer.sourceOrganization.name: required; type="string"; response200(application/json).transfer.targetOrganization: required; type="object"; response200(application/json).transfer.targetOrganization.id: required; type="string"; format="uuid"; response200(application/json).transfer.targetOrganization.name: required; type="string"; response200(application/json).transfer.requestedBy: required; type="object"; response200(application/json).transfer.requestedBy.id: required; type="integer"; response200(application/json).transfer.requestedBy.name: required; type="string"; response200(application/json).transfer.requestedBy.email: required; type="string"; response200(application/json).transfer.registration: required; Set when the domain was purchased through short.io; its renewal billing moves with it; anyOf=[type="object" | type="null"]; response200(application/json).transfer.registration anyOf1.renewalPrice: required; Yearly renewal price in cents the receiving organization will be billed; anyOf=[type="integer" | type="null"]; response200(application/json).transfer.registration anyOf1.expiresAt: required; anyOf=[type="string"; format="date-time" | type="null"]; response200(application/json).transfer.registration anyOf1.autoRenew: required; type="boolean"; response200(application/json).warnings: type="array"; Plan limits the target organization currently exceeds; it must upgrade before accepting; items(type="string").

    POST /domains/transfer/{domainId}

  • Destructive

    Upload domain favicon

    Uploads a favicon for the domain as multipart form data. An existing favicon is replaced. Request contract: path.domainId: required; Domain ID; type="number"; body(application/json): required; object/union schema.

    PUT /domains/favicon/{domainId}

  • Destructive

    Delete domain favicon

    Deletes the domain's favicon. Request contract: path.domainId: required; Domain ID; type="number".

    DELETE /domains/favicon/{domainId}

  • Destructive

    Accept a pending domain transfer

    Request contract: path.transferId: required; Transfer request id; type="string"; format="uuid". Successful response contract: response200(application/json): type="object"; response200(application/json).success: required; type="boolean"; enum=[true].

    POST /domains/transfers/{transferId}/accept

  • Destructive

    Remove allowed hostname

    Removes a hostname from the domain's allowed-hostnames list. Request contract: query.hostname: required; Referrer hostname to remove from the allowlist; type="string"; minLength=1; path.domainId: required; Domain ID; type="integer"; minimum=1.

    DELETE /domains/allowedHostnames/{domainId}

  • Destructive

    Unmark domain as favorite

    Removes the domain from the current user's favorites. Request contract: path.domainId: required; Domain ID; type="integer"; minimum=1.

    DELETE /domains/favorite/{domainId}

  • Destructive

    Delete domain theme

    Deletes theme settings for the domain, reverting it to the default theme. Request contract: path.domainId: required; Domain ID; type="integer"; minimum=1.

    DELETE /domains/theme/{domainId}

  • Destructive

    Remove IP exclusion

    Removes an IP address from the domain's exclusion list. Request contract: query.ip: required; IPv4 address to remove from exclusion list; type="string"; format="ipv4"; path.domainId: required; Domain ID; type="integer"; minimum=1.

    DELETE /domains/ipExclusions/{domainId}

  • Destructive

    Disable S3 export

    Disables daily S3 click export for the domain. Request contract: path.domainId: required; Domain ID; type="integer"; minimum=1.

    DELETE /domains/s3exports/{domainId}

Domain DNS

  • Read

    List DNS records

    Returns the customer-managed DNS records for a domain registered through Short.io. Request contract: query.hostname: required; Domain hostname; type="string"; format="fqdn".

    GET /domains/dnsRecord

  • Write

    Create DNS records

    Creates one or more DNS records for a domain registered through Short.io. Request contract: body(application/json): required; type="object"; body(application/json).hostname: required; type="string"; format="fqdn"; Domain hostname; body(application/json).records: required; type="array"; DNS records to create; items(type="object"); body(application/json).records[].name: required; type="string"; DNS record name; body(application/json).records[].type: required; enum=["MX","TXT"]; DNS record type; body(application/json).records[].value: required; type="string"; DNS record value; body(application/json).records[].ttl: required; type="integer"; minimum=60; maximum=7200; DNS record TTL in seconds.

    POST /domains/dnsRecord

  • Destructive

    Delete DNS records

    Deletes DNS records of the given name and type. Omit `value` to remove every matching record. Request contract: query.hostname: required; Domain hostname; type="string"; format="fqdn"; query.name: required; DNS record name; type="string"; query.type: required; DNS record type; enum=["MX","TXT"]; query.value: Specific value to delete, otherwise all matching are removed; type="string".

    DELETE /domains/dnsRecord

Audit

  • Read

    List audit log entries

    Lists audit log entries for a team or a domain. Request contract: query.domainId: required; Domain to fetch audit records for; type="number"; query.userId: Filter records by team member user id; type="integer"; query.teamId: Team scope; current user must be owner; type="integer"; query.actionType: Filter records by operation type, e.g. "create", "update", "delete"; type="string"; query.linkId: Filter records by link id, matched exactly as stored; type="string"; query.limit: Maximum number of records to return; type="integer"; minimum=1; query.pageToken: Pagination cursor from previous response; type="string". Successful response contract: response200(application/json): type="object"; response200(application/json).records: required; type="array"; items(type="object"); response200(application/json).records[].id: required; type="string"; Audit record TimeUUID; response200(application/json).records[].UserId: required; type="number"; Acting user id; response200(application/json).records[].DomainId: required; type="number"; Domain id the action was performed against; response200(application/json).records[].TeamId: required; Team id, if the action was scoped to a team; anyOf=[type="number" | type="null"]; response200(application/json).records[].target: required; type="string"; Audited entity, e.g. "link", "ipExclusion"; response200(application/json).records[].actionType: required; type="string"; Action performed, e.g. "create", "update"; response200(application/json).records[].createdAt: required; type="string"; ISO timestamp derived from the record TimeUUID; response200(application/json).records[].ttl: type="string"; ISO timestamp when the record expires; response200(application/json).records[].userEmail: required; type="string"; Email of the requesting user; response200(application/json).records[].apiKeyId: required; API key id used to perform the action, if any; anyOf=[type="string" | type="null"]; response200(application/json).records[].linkId: required; Link id the action targeted, if any; anyOf=[type="string" | type="null"]; response200(application/json).records[].statusCode: required; HTTP status code returned by the audited request. Null for legacy records written before status tracking.; anyOf=[type="integer" | type="null"]; response200(application/json).records[].operationTime: required; Total request duration in milliseconds (request received → response sent). Null for legacy records written before timing was tracked.; anyOf=[type="integer" | type="null"]; response200(application/json).nextPageToken: required; Cursor to pass as `pageToken` to fetch the next page, or null when the listing is exhausted; anyOf=[type="string" | type="null"].

    GET /audit

Link Bundles

  • Read

    Get bundle templates

    Returns all available bundle templates

    GET /links/bundle/templates

  • Read

    Get bundle by ID

    Returns bundle details by ULID id Request contract: path.id: required; Bundle ULID id; type="string".

    GET /links/bundle/{id}

  • Write

    Update bundle

    Updates bundle details, social media links, and branding Request contract: path.id: required; Bundle ULID id; type="string"; body(application/json): required; type="object"; body(application/json).DomainId: type="number"; Domain ID the bundle belongs to; body(application/json).TemplateId: type="string"; nullable=true; Template ID; body(application/json).title: type="string"; nullable=true; Bundle title; body(application/json).description: type="string"; nullable=true; Bundle description; body(application/json).logoURL: type="string"; nullable=true; Profile or logo URL; body(application/json).backgroundImageURL: type="string"; nullable=true; Background image URL; body(application/json).twitterUsername: type="string"; nullable=true; Twitter username (without @); body(application/json).fbUsername: type="string"; nullable=true; Facebook username; body(application/json).linkedinCompanyname: type="string"; nullable=true; LinkedIn company name (mutually exclusive with linkedinUsername); body(application/json).linkedinUsername: type="string"; nullable=true; LinkedIn username (mutually exclusive with linkedinCompanyname); body(application/json).instagramUsername: type="string"; nullable=true; Instagram username (without @); body(application/json).whatsappURL: type="string"; nullable=true; WhatsApp URL (must start with whatsapp:// or https://); body(application/json).viberURL: type="string"; nullable=true; Viber URL (must start with viber:// or https://); body(application/json).telegramURL: type="string"; nullable=true; Telegram URL; body(application/json).threadsUsername: type="string"; nullable=true; Threads username (without @); body(application/json).mastodonUsername: type="string"; nullable=true; Mastodon username; body(application/json).blueskyUsername: type="string"; nullable=true; Bluesky username; body(application/json).email: type="string"; format="email"; nullable=true; Contact email address.

    PUT /links/bundle/{id}

  • Write

    Upload bundle logo

    Uploads a logo image for a bundle Request contract: path.id: required; Bundle ULID id; type="string"; body(application/json): required; Raw logo image bytes.

    POST /links/bundle/{id}/photo

  • Write

    Upload bundle background image

    Uploads a background image for a bundle Request contract: path.id: required; Bundle ULID id; type="string"; body(application/json): required; Raw background image bytes.

    PUT /links/bundle/{id}/background-image

  • Write

    Create bundle

    Creates a new link bundle with customizable template, social media links, and branding Request contract: body(application/json): required; allOf=[type="object" | type="object"]; body(application/json).DomainId: required; type="number"; Domain ID where the bundle will be created; body(application/json).TemplateId: required; type="string"; Template ID from available templates; body(application/json).title: type="string"; nullable=true; Bundle title; body(application/json).description: type="string"; nullable=true; Bundle description; body(application/json).logoURL: type="string"; nullable=true; Profile or logo URL; body(application/json).backgroundImageURL: type="string"; nullable=true; Background image URL; body(application/json).twitterUsername: type="string"; nullable=true; Twitter username (without @); body(application/json).fbUsername: type="string"; nullable=true; Facebook username; body(application/json).linkedinCompanyname: type="string"; nullable=true; LinkedIn company name (mutually exclusive with linkedinUsername); body(application/json).linkedinUsername: type="string"; nullable=true; LinkedIn username (mutually exclusive with linkedinCompanyname); body(application/json).instagramUsername: type="string"; nullable=true; Instagram username (without @); body(application/json).whatsappURL: type="string"; nullable=true; WhatsApp URL (must start with whatsapp:// or https://); body(application/json).viberURL: type="string"; nullable=true; Viber URL (must start with viber:// or https://); body(application/json).telegramURL: type="string"; nullable=true; Telegram URL; body(application/json).threadsUsername: type="string"; nullable=true; Threads username (without @); body(application/json).mastodonUsername: type="string"; nullable=true; Mastodon username; body(application/json).blueskyUsername: type="string"; nullable=true; Bluesky username; body(application/json).email: type="string"; format="email"; nullable=true; Contact email address.

    POST /links/bundle

  • Write

    Add link to bundle

    Adds a short link to a bundle. If the link doesn't exist, it will be created. Request contract: path.id: required; Bundle ULID id; type="string"; body(application/json): required; type="object"; body(application/json).path: required; type="string"; Short link path or full URL; body(application/json).title: required; type="string"; Display title for the link.

    POST /links/bundle/{id}/links

  • Destructive

    Delete bundle

    Deletes a bundle by ULID id Request contract: path.id: required; Bundle ULID id; type="string".

    DELETE /links/bundle/{id}

  • Destructive

    Remove link from bundle

    Removes a link from a bundle by its link template ID Request contract: path.id: required; Bundle ULID id; type="string"; path.linkTemplateId: required; Link template ID to remove; type="string".

    DELETE /links/bundle/{id}/links/{linkTemplateId}

Posts

  • Read

    Get post by ID

    Request contract: path.id: required; Link id string; type="string".

    GET /links/post/{id}

  • Write

    Create post

    Creates a content page rendered at a short link Request contract: body(application/json): required; allOf=[type="object" | type="object"]; body(application/json).DomainId: required; type="number"; Domain ID where the post will be created; body(application/json).path: type="string"; Short link path (auto-generated if omitted); body(application/json).title: required; type="string"; Post title; body(application/json).description: type="string"; Short post description / meta; body(application/json).coverImageURL: type="string"; Cover image URL; body(application/json).body: required; type="string"; Post body (Markdown).

    POST /links/post

  • Write

    Update post

    Request contract: path.id: required; Link id string; type="string"; body(application/json): required; type="object"; body(application/json).title: required; type="string"; Post title; body(application/json).description: type="string"; Short post description / meta; body(application/json).coverImageURL: type="string"; Cover image URL; body(application/json).body: required; type="string"; Post body (Markdown).

    PUT /links/post/{id}

  • Write

    Upload post cover image

    Request contract: path.id: required; Link id string; type="string"; body(application/json): required; Raw cover image bytes.

    POST /links/post/{id}/cover

  • Destructive

    Delete post

    Request contract: path.id: required; Link id string; type="string".

    DELETE /links/post/{id}

Pages

  • Read

    Get AI page by ID

    Request contract: path.id: required; Link id string; type="string".

    GET /links/page/{id}

  • Write

    Create AI page

    Generates a self-contained HTML page from a prompt and serves it at a new short link. Responds with an `application/x-ndjson` stream, one JSON event per line: `start` (`maxOutputTokens`), `heartbeat` (`elapsedMs`, `outputChars`) at least every 10 seconds while the page is generated, then exactly one terminal event - `done` (`page`) or `error` (`code`, `status`, `message`). `code` is `prompt_rejected` (400), `generation_failed` (502), `generation_timeout` (504), `link_refused` (the status the link write was refused with) or `internal_error` (500). Refusals decided before generation starts are ordinary JSON replies with their status code. Request contract: body(application/json): required; type="object"; body(application/json).DomainId: required; type="number"; Domain ID where the page will be created; body(application/json).path: type="string"; Short link path (auto-generated if omitted); body(application/json).title: type="string"; Link title (taken from the generated page's if omitted); body(application/json).prompt: required; type="string"; minLength=3; maxLength=4000; pattern="^[^\\u0000-\\u0008\\u000B-\\u001F\\u007F]*$"; What the page should be. The HTML is generated from it and cannot be edited directly.

    POST /links/page

  • Destructive

    Regenerate AI page

    Generates a new HTML document from a new prompt and replaces the page with it. Responds with an `application/x-ndjson` stream, one JSON event per line: `start` (`maxOutputTokens`), `heartbeat` (`elapsedMs`, `outputChars`) at least every 10 seconds while the page is generated, then exactly one terminal event - `done` (`page`) or `error` (`code`, `status`, `message`). `code` is `prompt_rejected` (400), `generation_failed` (502), `generation_timeout` (504), `link_refused` (the status the link write was refused with) or `internal_error` (500). Refusals decided before generation starts are ordinary JSON replies with their status code. Request contract: path.id: required; Link id string; type="string"; body(application/json): required; type="object"; body(application/json).prompt: required; type="string"; minLength=3; maxLength=4000; pattern="^[^\\u0000-\\u0008\\u000B-\\u001F\\u007F]*$"; What the page should be. The HTML is generated from it and cannot be edited directly.

    PUT /links/page/{id}

  • Destructive

    Delete AI page

    Request contract: path.id: required; Link id string; type="string".

    DELETE /links/page/{id}

See How connections work for access and permissions, or browse all integrations.

Reference date: October 29, 2026. Short Io API docs.