{"openapi":"3.1.0","info":{"title":"Short.io API","version":"1.0.0","x-scalar-sdk-installation":[{"lang":"Node","description":"Install the official **Short.io Node.js SDK** from npm:","source":"npm install @short.io/client-node"}]},"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{}},"paths":{"/links/opengraph/debug":{"post":{"summary":"Fetch and inspect OpenGraph tags for a URL (public, hCaptcha-protected)","tags":["Link queries"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["url","hcaptchaToken"],"properties":{"hcaptchaToken":{"type":"string","description":"hCaptcha verification token","example":"10000000-aaaa-bbbb-cccc-000000000001"}}}}},"required":true},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["title"],"properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"HTML document title, if present"},"ogTags":{"type":"array","items":{"type":"object","required":["propertyName","propertyValue"],"properties":{"propertyName":{"type":"string","description":"OpenGraph property name","example":"og:title"},"propertyValue":{"type":"string","description":"OpenGraph property value","example":"Example Title"}},"description":"OpenGraph tag"},"description":"OpenGraph tags extracted from the page"}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Bad request error message"}}}}}}},"operationId":"createDebug","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await createDebug({\n    \"body\": {\n        \"hcaptchaToken\": \"10000000-aaaa-bbbb-cccc-000000000001\"\n    }\n});\n"}]}},"/links/opengraph/{domainId}/{linkId}":{"get":{"summary":"Get link opengraph properties","tags":["Link queries"],"parameters":[{"schema":{"type":"number"},"example":12345,"in":"path","name":"domainId","required":true,"description":"Domain ID the link belongs to"},{"schema":{"type":"string"},"example":"lnk_1A2b_3Cd4Ef5Gh","in":"path","name":"linkId","required":true,"description":"Numeric link ID or encoded link ID string"}],"responses":{"200":{"description":"Default Response"}},"operationId":"getOpengraph","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await getOpengraph({\n    \"path\": {\n        \"domainId\": 12345,\n        \"linkId\": \"lnk_1A2b_3Cd4Ef5Gh\"\n    }\n});\n"}]},"put":{"summary":"Set link opengraph properties","tags":["Link Management"],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"array","prefixItems":[{"type":"string","enum":["title","type","image","url","audio","description","determiner","locale","locale:alternate","site_name","video","article:published_time","article:modified_time","article:expiration_time","article:author","article:section","article:tag","updated_time","image:url","image:secure_url","image:type","image:width","image:height","image:alt","music:duration","music:album","music:album:disc","music:album:track","music:musician","music:song","music:song:disc","music:song:track","music:release_date","music:creator","video:actor","video:actor:role","video:director","video:writer","video:duration","video:release_date","video:tag","video:series","book:author","book:isbn","book:release_date","book:tag","product:price:amount","product:price:currency","product:availability","product:condition","product:retailer_item_id","product:brand","product:category","product:color","product:size","product:material","product:pattern","product:shipping_cost:amount","product:shipping_cost:currency","product:shipping_weight:value","product:shipping_weight:units","product:weight:value","product:weight:units","product:sale_price:amount","product:sale_price:currency","product:sale_price_dates:start","product:sale_price_dates:end","product:expiration_time","product:original_price:amount","product:original_price:currency","product:gender","product:age_group","product:target_gender","product:retailer_part_no","product:mfr_part_no","product:upc","product:ean","product:isbn","product:plural_title","product:item_group_id","profile:first_name","profile:last_name","profile:username","profile:gender","twitter:card","twitter:site","twitter:site:id","twitter:creator","twitter:creator:id","twitter:description","twitter:title","twitter:image","twitter:image:alt","twitter:player","twitter:player:width","twitter:player:height","twitter:player:stream","twitter:app:name:iphone","twitter:app:id:iphone","twitter:app:url:iphone","twitter:app:name:ipad","twitter:app:id:ipad","twitter:app:url:ipad","twitter:app:name:googleplay","twitter:app:id:googleplay","twitter:app:url:googleplay","twitter:app:country"],"description":"opengraph tag name","examples":["title"]},{"type":"string","examples":["My Link Title"],"description":"opengraph tag value"}],"items":false,"minItems":2}},"example":["title","My title"]}}},"parameters":[{"schema":{"type":"number"},"example":12345,"in":"path","name":"domainId","required":true,"description":"Domain ID the link belongs to"},{"schema":{"type":"string"},"example":"lnk_1A2b_3Cd4Ef5Gh","in":"path","name":"linkId","required":true,"description":"Numeric link ID or encoded link ID string"}],"responses":{"200":{"description":"Default Response"}},"operationId":"updateOpengraph","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await updateOpengraph({\n    \"path\": {\n        \"domainId\": 12345,\n        \"linkId\": \"lnk_1A2b_3Cd4Ef5Gh\"\n    },\n    \"body\": [\n        \"title\",\n        \"My title\"\n    ]\n});\n"}]}},"/links/deeplinks/debug":{"post":{"summary":"Fetch and inspect deep link configuration for a URL (public, hCaptcha-protected)","tags":["Link queries"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["url","hcaptchaToken"],"properties":{"hcaptchaToken":{"type":"string","description":"hCaptcha verification token","example":"10000000-aaaa-bbbb-cccc-000000000001"}}}}},"required":true},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["domain","apple","android"],"properties":{"domain":{"type":"string","description":"Hostname inspected","example":"example.com"},"apple":{"type":"object","required":["found","data","error"],"properties":{"found":{"type":"boolean","description":"Whether apple-app-site-association was found","example":true},"data":{"description":"Parsed apple-app-site-association contents"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Error while fetching, if any"}},"description":"Apple universal link configuration"},"android":{"type":"object","required":["found","data","error"],"properties":{"found":{"type":"boolean","description":"Whether assetlinks.json was found","example":true},"data":{"description":"Parsed assetlinks.json contents"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Error while fetching, if any"}},"description":"Android app link configuration"}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Bad request error message"}}}}}}},"operationId":"createDebug","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await createDebug({\n    \"body\": {\n        \"hcaptchaToken\": \"10000000-aaaa-bbbb-cccc-000000000001\"\n    }\n});\n"}]}},"/link_country/{linkId}":{"get":{"summary":"Get link countries","tags":["Link Targeting"],"parameters":[{"schema":{"type":"string"},"example":"12345","in":"query","name":"domainId","required":false,"description":"Domain ID, required only when using a legacy numeric link ID"},{"schema":{"type":"string"},"example":"lnk_1A2b_3Cd4Ef5Gh","in":"path","name":"linkId","required":true,"description":"Numeric link ID or encoded link ID string"}],"responses":{"200":{"description":"Default Response"}},"operationId":"getLinkCountry","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await getLinkCountry({\n    \"path\": {\n        \"linkId\": \"lnk_1A2b_3Cd4Ef5Gh\"\n    },\n    \"query\": {\n        \"domainId\": \"12345\"\n    }\n});\n"}]},"post":{"summary":"Create link country","tags":["Link Targeting"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["country","originalURL"],"properties":{"country":{"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"],"description":"Country code"},"originalURL":{"type":"string","format":"uri","description":"Destination URL for visitors from this country","example":"https://example.com/us"}}}}},"required":true},"parameters":[{"schema":{"type":"string"},"example":"12345","in":"query","name":"domainId","required":false,"description":"Domain ID, required only when using a legacy numeric link ID"},{"schema":{"type":"string"},"example":"lnk_1A2b_3Cd4Ef5Gh","in":"path","name":"linkId","required":true,"description":"Numeric link ID or encoded link ID string"}],"responses":{"200":{"description":"Default Response"}},"operationId":"createLinkCountry","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await createLinkCountry({\n    \"path\": {\n        \"linkId\": \"lnk_1A2b_3Cd4Ef5Gh\"\n    },\n    \"query\": {\n        \"domainId\": \"12345\"\n    },\n    \"body\": {\n        \"country\": \"AD\",\n        \"originalURL\": \"https://example.com/us\"\n    }\n});\n"}]}},"/link_country/bulk/{linkId}":{"post":{"summary":"Create link countries in bulk","tags":["Link Targeting"],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["country","originalURL"],"properties":{"country":{"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"],"description":"Country code"},"originalURL":{"type":"string","description":"Destination URL for visitors from this country","example":"https://example.com/us"}},"description":"Country-specific redirect rule"},"description":"List of country-specific redirect rules to create"}}},"description":"List of country-specific redirect rules to create"},"parameters":[{"schema":{"type":"string"},"example":"12345","in":"query","name":"domainId","required":false,"description":"Domain ID, required only when using a legacy numeric link ID"},{"schema":{"type":"string"},"example":"lnk_1A2b_3Cd4Ef5Gh","in":"path","name":"linkId","required":true,"description":"Numeric link ID or encoded link ID string"}],"responses":{"200":{"description":"Default Response"}},"operationId":"createBulk","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await createBulk({\n    \"path\": {\n        \"linkId\": \"lnk_1A2b_3Cd4Ef5Gh\"\n    },\n    \"query\": {\n        \"domainId\": \"12345\"\n    },\n    \"body\": [\n        {\n            \"country\": \"AD\",\n            \"originalURL\": \"https://example.com/us\"\n        }\n    ]\n});\n"}]}},"/link_country/{linkId}/{country}":{"delete":{"summary":"Delete link country","tags":["Link Targeting"],"parameters":[{"schema":{"type":"string"},"example":"12345","in":"query","name":"domainId","required":false,"description":"Domain ID, required only when using a legacy numeric link ID"},{"schema":{"type":"string"},"example":"lnk_1A2b_3Cd4Ef5Gh","in":"path","name":"linkId","required":true,"description":"Numeric link ID or encoded link ID string"},{"schema":{"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"]},"in":"path","name":"country","required":true,"description":"Country code"}],"responses":{"200":{"description":"Default Response"}},"operationId":"deleteLinkCountry","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await deleteLinkCountry({\n    \"path\": {\n        \"linkId\": \"lnk_1A2b_3Cd4Ef5Gh\",\n        \"country\": \"AD\"\n    },\n    \"query\": {\n        \"domainId\": \"12345\"\n    }\n});\n"}]}},"/link_region/{linkId}":{"get":{"summary":"Get link regions","tags":["Link Targeting"],"parameters":[{"schema":{"type":"string"},"example":"12345","in":"query","name":"domainId","required":false,"description":"Domain ID, required only when using a legacy numeric link ID"},{"schema":{"type":"string"},"example":"lnk_1A2b_3Cd4Ef5Gh","in":"path","name":"linkId","required":true,"description":"Numeric link ID or encoded link ID string"}],"responses":{"200":{"description":"Default Response"}},"operationId":"getLinkRegion","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await getLinkRegion({\n    \"path\": {\n        \"linkId\": \"lnk_1A2b_3Cd4Ef5Gh\"\n    },\n    \"query\": {\n        \"domainId\": \"12345\"\n    }\n});\n"}]},"post":{"summary":"Add region targeting to link","tags":["Link Targeting"],"description":"Add region targeting to link","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["country","region","originalURL"],"properties":{"country":{"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"],"description":"Country code"},"region":{"type":"string","description":"ISO 3166-2 region code","example":"CA"},"originalURL":{"type":"string","description":"Destination URL for visitors from this region","example":"https://example.com"}}}}},"required":true},"parameters":[{"schema":{"type":"integer","minimum":1},"example":12345,"in":"query","name":"domainId","required":false,"description":"Domain ID"},{"schema":{"type":"string"},"example":"lnk_1A2b_3Cd4Ef5Gh","in":"path","name":"linkId","required":true,"description":"Numeric link ID or encoded link ID string"}],"responses":{"200":{"description":"Default Response"}},"operationId":"createLinkRegion","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await createLinkRegion({\n    \"path\": {\n        \"linkId\": \"lnk_1A2b_3Cd4Ef5Gh\"\n    },\n    \"query\": {\n        \"domainId\": 12345\n    },\n    \"body\": {\n        \"country\": \"AD\",\n        \"region\": \"CA\",\n        \"originalURL\": \"https://example.com\"\n    }\n});\n"}]}},"/link_region/list/{country}":{"get":{"summary":"Get all regions by country","tags":["Link Targeting"],"parameters":[{"schema":{"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"]},"in":"path","name":"country","required":true,"description":"Country code"}],"responses":{"200":{"description":"Default Response"}},"operationId":"getList","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await getList({\n    \"path\": {\n        \"country\": \"AD\"\n    }\n});\n"}]}},"/link_region/bulk/{linkId}":{"post":{"summary":"Create link regions in bulk","tags":["Link Targeting"],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["country","region","originalURL"],"properties":{"country":{"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"],"description":"Country code"},"region":{"type":"string","description":"ISO 3166-2 region code","example":"CA"},"originalURL":{"type":"string","description":"Destination URL for visitors from this region","example":"https://example.com"}},"description":"Region-specific redirect rule"},"description":"List of region-specific redirect rules to create"}}},"description":"List of region-specific redirect rules to create"},"parameters":[{"schema":{"type":"integer"},"example":12345,"in":"query","name":"domainId","required":false,"description":"Domain ID, required only when using a legacy numeric link ID"},{"schema":{"type":"string"},"example":"lnk_1A2b_3Cd4Ef5Gh","in":"path","name":"linkId","required":true,"description":"Numeric link ID or encoded link ID string"}],"responses":{"200":{"description":"Default Response"}},"operationId":"createBulk","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await createBulk({\n    \"path\": {\n        \"linkId\": \"lnk_1A2b_3Cd4Ef5Gh\"\n    },\n    \"query\": {\n        \"domainId\": 12345\n    },\n    \"body\": [\n        {\n            \"country\": \"AD\",\n            \"region\": \"CA\",\n            \"originalURL\": \"https://example.com\"\n        }\n    ]\n});\n"}]}},"/link_region/{linkId}/{country}/{region}":{"delete":{"summary":"Delete link region by country","tags":["Link Targeting"],"parameters":[{"schema":{"type":"string"},"example":"12345","in":"query","name":"domainId","required":false,"description":"Domain ID, required only when using a legacy numeric link ID"},{"schema":{"type":"string"},"example":"lnk_1A2b_3Cd4Ef5Gh","in":"path","name":"linkId","required":true,"description":"Numeric link ID or encoded link ID string"},{"schema":{"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"]},"in":"path","name":"country","required":true,"description":"Country code"},{"schema":{"type":"string"},"example":"CA","in":"path","name":"region","required":true,"description":"ISO 3166-2 region code"}],"responses":{"200":{"description":"Default Response"}},"operationId":"deleteLinkRegion","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await deleteLinkRegion({\n    \"path\": {\n        \"linkId\": \"lnk_1A2b_3Cd4Ef5Gh\",\n        \"country\": \"AD\",\n        \"region\": \"CA\"\n    },\n    \"query\": {\n        \"domainId\": \"12345\"\n    }\n});\n"}]}},"/links/permissions/{domainId}/{linkId}":{"get":{"summary":"Get link permissions","tags":["Link Management"],"parameters":[{"schema":{"type":"string"},"example":"12345","in":"path","name":"domainId","required":true,"description":"Domain ID the link belongs to"},{"schema":{"type":"string"},"example":"lnk_1A2b_3Cd4Ef5Gh","in":"path","name":"linkId","required":true,"description":"Numeric link ID or encoded link ID string"}],"responses":{"200":{"description":"List of permissions granted on the link","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["id","DomainId","UserId","LinkIdString"],"properties":{"id":{"type":"string","description":"Permission record ID","example":"perm_abc123"},"DomainId":{"type":"integer","description":"Domain ID","example":12345},"UserId":{"type":"integer","description":"User ID granted access","example":67890},"LinkIdString":{"type":"string","description":"Encoded link ID the permission applies to","example":"lnk_1A2b_3Cd4Ef5Gh"}},"description":"Link permission record"},"description":"List of permissions granted on the link"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Access denied error message"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Not found error message"}}}}}}},"operationId":"getPermission","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await getPermission({\n    \"path\": {\n        \"domainId\": \"12345\",\n        \"linkId\": \"lnk_1A2b_3Cd4Ef5Gh\"\n    }\n});\n"}]}},"/links/permissions/{domainId}/{linkId}/{userId}":{"post":{"summary":"Add link permission","tags":["Link Management"],"parameters":[{"schema":{"type":"string"},"example":"12345","in":"path","name":"domainId","required":true,"description":"Domain ID the link belongs to"},{"schema":{"type":"string","pattern":"lnk_[0-9a-zA-Z]+_[0-9a-zA-Z]+"},"example":"lnk_abc123_abcdef","in":"path","name":"linkId","required":true,"description":"Link ID"},{"schema":{"type":"string"},"example":"67890","in":"path","name":"userId","required":true,"description":"User ID to grant access to"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["id","DomainId","UserId","LinkIdString"],"properties":{"id":{"type":"string","description":"Permission record ID","example":"perm_abc123"},"DomainId":{"type":"integer","description":"Domain ID","example":12345},"UserId":{"type":"integer","description":"User ID granted access","example":67890},"LinkIdString":{"type":"string","pattern":"lnk_[0-9a-zA-Z]+_[0-9a-zA-Z]+","description":"Link ID","example":"lnk_abc123_abcdef"}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Bad request error message"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Payment required error message"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Access denied error message"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Not found error message"}}}}}}},"operationId":"createPermission","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await createPermission({\n    \"path\": {\n        \"domainId\": \"12345\",\n        \"linkId\": \"lnk_abc123_abcdef\",\n        \"userId\": \"67890\"\n    }\n});\n"}]},"delete":{"summary":"Delete link permissions","tags":["Link Management"],"parameters":[{"schema":{"type":"integer","minimum":1},"example":12345,"in":"path","name":"domainId","required":true,"description":"Domain ID the link belongs to"},{"schema":{"type":"string"},"example":"lnk_1A2b_3Cd4Ef5Gh","in":"path","name":"linkId","required":true,"description":"Numeric link ID or encoded link ID string"},{"schema":{"type":"string"},"example":"67890","in":"path","name":"userId","required":true,"description":"User ID whose permission is being revoked"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the permission was removed","example":true}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Payment required error message"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Access denied error message"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Not found error message"}}}}}}},"operationId":"deletePermission","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await deletePermission({\n    \"path\": {\n        \"domainId\": 12345,\n        \"linkId\": \"lnk_1A2b_3Cd4Ef5Gh\",\n        \"userId\": \"67890\"\n    }\n});\n"}]}},"/api/links":{"get":{"summary":"Link list","tags":["Link queries"],"description":"Get domain links","parameters":[{"schema":{"type":"integer","minimum":1},"example":12345,"in":"query","name":"domain_id","required":true,"description":"Domain ID"},{"schema":{"type":"integer","minimum":1,"maximum":150,"nullable":true},"example":50,"in":"query","name":"limit","required":false,"description":"Maximum number of links to return"},{"schema":{"type":"string"},"example":"lnk_1A2b_3Cd4Ef5Gh","in":"query","name":"idString","required":false,"description":"Link ID string for pagination cursor"},{"schema":{"type":"string"},"example":"2026-01-15T12:00:00.000Z","in":"query","name":"createdAt","required":false,"description":"Pagination cursor by link creation date"},{"schema":{"type":"string","format":"date-time"},"example":"2026-04-01T00:00:00.000Z","in":"query","name":"beforeDate","required":false,"description":"Return links created before this date"},{"schema":{"type":"string","format":"date-time"},"example":"2026-01-01T00:00:00.000Z","in":"query","name":"afterDate","required":false,"description":"Return links created after this date"},{"schema":{"type":"string","enum":["asc","desc"]},"example":"desc","in":"query","name":"dateSortOrder","required":false,"description":"Sort order by creation date"},{"schema":{"type":"string"},"example":"page_1a2b3c_lnk_4d5e6f","in":"query","name":"pageToken","required":false,"description":"Opaque cursor for paginating link results"},{"schema":{"type":"string"},"example":"fld_1a2b3c4d","in":"query","name":"folderId","required":false,"description":"Restrict results to a specific folder"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["count","links","nextPageToken"],"properties":{"count":{"type":"integer","description":"Total number of matching links","example":42},"links":{"type":"array","items":{"allOf":[{"type":"object","required":["originalURL"],"properties":{"originalURL":{"type":"string","url":"destination","description":"Original URL","examples":["https://example.com"]},"cloaking":{"type":"boolean","description":"Cloaking"},"password":{"type":"string","description":"Link password","examples":["s3cur3p@ssw0rd"]},"expiresAt":{"anyOf":[{"type":"integer","nullable":true},{"type":"string","format":"iso-date-time","nullable":true}],"description":"Link expiration date in milliseconds or ISO string","examples":["2026-04-18T11:06:05.347Z"]},"expiredURL":{"type":"string","nullable":true,"url":"destination","description":"Expired URL","examples":["https://example.com/expired"]},"title":{"type":"string","description":"Link title"},"tags":{"type":"array","items":{"type":"string"},"description":"Array of link tags"},"utmSource":{"type":"string","description":"set utm_source parameter to destination link","examples":["cpc","organic"]},"utmMedium":{"type":"string","description":"set utm_medium parameter to destination link","examples":["banner","email"]},"utmCampaign":{"type":"string","description":"set utm_campaign parameter to destination link","examples":["summer_sale"]},"utmTerm":{"type":"string","description":"set utm_term parameter to destination link","examples":["running_shoes"]},"utmContent":{"type":"string","description":"set utm_content parameter to destination link","examples":["cta_button"]},"ttl":{"anyOf":[{"type":"string","format":"iso-date-time","nullable":true},{"type":"integer","nullable":true}],"description":"Time to live in milliseconds or ISO string","examples":["2026-04-18T11:06:05.349Z"]},"androidURL":{"type":"string","url":"destination","description":"Android URL","nullable":true,"examples":["https://play.google.com/store/apps/details?id=com.example.app"]},"iphoneURL":{"type":"string","url":"destination","description":"iPhone URL","nullable":true,"examples":["https://apps.apple.com/us/app/example-app/id1234567890"]},"clicksLimit":{"type":"integer","nullable":true,"minimum":1,"description":"disable link after specified number of clicks","examples":[100]},"passwordContact":{"type":"boolean","description":"Provide your email to users to get a password","nullable":true},"skipQS":{"type":"boolean","description":"Skip query string merging","default":false},"archived":{"type":"boolean","description":"Link is archived","default":false},"splitURL":{"type":"string","url":"destination","description":"Split URL","nullable":true,"examples":["https://example.com/split"]},"splitPercent":{"type":"integer","nullable":true,"minimum":1,"maximum":100,"description":"Split URL percentage","examples":[50]},"splitURLV2":{"type":"array","items":{"type":"object","required":["url","percent"],"properties":{"url":{"type":"string","url":"destination","description":"Split URL destination"},"percent":{"type":"integer","minimum":1,"maximum":100,"description":"Traffic percentage"}}},"description":"Split URL configurations for multi-way A/B testing","maxItems":10,"nullable":true},"integrationAdroll":{"type":"string","description":"Adroll integration","nullable":true},"integrationFB":{"type":"string","description":"Facebook integration","nullable":true},"integrationTT":{"type":"string","description":"TikTok integration","nullable":true},"integrationGA":{"type":"string","description":"Google Analytics integration","nullable":true},"integrationGTM":{"type":"string","description":"Google Tag Manager integration","nullable":true}}},{"type":"object","required":["idString","id","shortURL","secureShortURL","path","displayPath","createdAt","updatedAt"],"properties":{"idString":{"type":"string","description":"Link ID"},"id":{"type":"string","description":"Link ID"},"shortURL":{"type":"string","url":"short","description":"Short URL","examples":["https://short.gy/abc123"]},"secureShortURL":{"type":"string","url":"short","description":"Secure short URL","examples":["https://short.gy/abc123"]},"path":{"anyOf":[{"type":"string","description":"Link slug. For case-insensitive domains, this is the normalized lowercase version of the path.","examples":["my-link"]},{"type":"null"}]},"displayPath":{"anyOf":[{"type":"string","description":"Original path preserving the case as provided during creation. Set only for case-insensitive domains when the path contains uppercase characters, otherwise null.","examples":["My-Link"]},{"type":"null"}]},"redirectType":{"type":"string","description":"HTTP code for redirect","enum":["301","302","307","308"]},"createdAt":{"anyOf":[{"type":"string","format":"iso-date-time"},{"type":"null"}],"description":"Link creation date in ISO format"},"updatedAt":{"anyOf":[{"type":"string","format":"iso-date-time"},{"type":"null"}],"description":"Link last update date in ISO format"},"FolderId":{"anyOf":[{"type":"string","description":"Folder ID","examples":["abc123"]},{"type":"null"}]},"DomainId":{"type":"integer","description":"Domain ID","examples":[1]},"OwnerId":{"type":"integer","description":"Owner ID","examples":[1]},"hasPassword":{"type":"boolean","description":"Link has password","default":false},"source":{"enum":["website","api","public","spreadsheets","slack","telegram",""],"description":"Link source","examples":["api"]},"User":{"anyOf":[{"type":"object","required":["id","name","email","photoURL"],"properties":{"id":{"type":"integer","description":"Creator user ID","examples":[123]},"name":{"anyOf":[{"type":"string","description":"Creator name","examples":["John Doe"]},{"type":"null"}]},"email":{"type":"string","description":"Creator email","examples":["a@example.com"]},"photoURL":{"anyOf":[{"type":"string","description":"User photo URL","examples":["https://example.com/photo.jpg"]},{"type":"null"}]}}},{"type":"null"}]}}}]},"description":"List of links"},"nextPageToken":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null if no more results","example":"page_1a2b3c_lnk_4d5e6f"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Payment required error message"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Access denied error message"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Not found error message"}}}}}}},"operationId":"listLink","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await listLink({\n    \"query\": {\n        \"domain_id\": 12345,\n        \"limit\": 50,\n        \"idString\": \"lnk_1A2b_3Cd4Ef5Gh\",\n        \"createdAt\": \"2026-01-15T12:00:00.000Z\",\n        \"beforeDate\": \"2026-04-01T00:00:00.000Z\",\n        \"afterDate\": \"2026-01-01T00:00:00.000Z\",\n        \"dateSortOrder\": \"desc\",\n        \"pageToken\": \"page_1a2b3c_lnk_4d5e6f\",\n        \"folderId\": \"fld_1a2b3c4d\"\n    }\n});\n"}]}},"/links/qr/{linkIdString}":{"post":{"summary":"Generate QR code for the link","tags":["Link Management"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["useDomainSettings"],"properties":{"color":{"type":"string","pattern":"^[0-9A-Fa-f]{6,8}$","description":"Hex color code (6 or 8 chars, no # prefix)","example":"FF5733"},"backgroundColor":{"type":"string","pattern":"^[0-9A-Fa-f]{6,8}$","description":"Hex color code (6 or 8 chars, no # prefix)","example":"FF5733"},"size":{"type":"number","minimum":1,"maximum":99,"description":"QR code size scale factor","example":10},"type":{"type":"string","enum":["png","svg"],"default":"png","description":"QR code image format","example":"png"},"useDomainSettings":{"type":"boolean","default":true,"description":"Use QR code settings configured on the domain","example":true}}}}},"required":true},"parameters":[{"schema":{"type":"string","pattern":"lnk_[0-9a-zA-Z]+_[0-9a-zA-Z]+"},"example":"lnk_abc123_abcdef","in":"path","name":"linkIdString","required":true,"description":"Link ID"},{"schema":{"type":"string"},"example":"application/json","in":"header","name":"accept","required":false,"description":"Accept header; use application/json to receive a hosted URL"}],"responses":{"200":{"description":"Default Response"}},"operationId":"createQr","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await createQr({\n    \"path\": {\n        \"linkIdString\": \"lnk_abc123_abcdef\"\n    },\n    \"body\": {\n        \"color\": \"FF5733\",\n        \"backgroundColor\": \"FF5733\",\n        \"size\": 10,\n        \"type\": \"png\",\n        \"useDomainSettings\": true\n    }\n});\n"}]}},"/links/qr/bulk":{"post":{"summary":"Generate QR codes for the link in bulk","tags":["Link Management"],"description":"Generate QR codes for the link in bulk. Rate limit - 1 request per minute","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["type","useDomainSettings","linkIds"],"properties":{"color":{"type":"string","pattern":"^[0-9A-Fa-f]{6,8}$","description":"Hex color code (6 or 8 chars, no # prefix)","example":"FF5733"},"backgroundColor":{"type":"string","pattern":"^[0-9A-Fa-f]{6,8}$","description":"Hex color code (6 or 8 chars, no # prefix)","example":"FF5733"},"size":{"type":"number","minimum":1,"maximum":99,"description":"QR code size scale factor","example":10},"type":{"type":"string","enum":["png","svg"],"default":"png","description":"QR code image format","example":"png"},"useDomainSettings":{"type":"boolean","default":true,"description":"Use QR code settings configured on the domain","example":true},"noExcavate":{"type":"boolean","description":"Disable logo excavation (cutout) in the QR code","example":false},"linkIds":{"type":"array","items":{"type":"string","pattern":"^(\\d+|lnk_\\w+)$","description":"Link ID or encoded link ID string","example":"lnk_1A2b_3Cd4Ef5Gh"},"maxItems":150,"description":"List of link IDs to generate QR codes for"},"domainId":{"type":"string","description":"Domain ID for legacy numeric link IDs","example":"12345"}}}}},"required":true},"responses":{"201":{"description":"ZIP file containing QR codes","content":{"application/json":{"schema":{"description":"ZIP file containing QR codes"}}}}},"operationId":"bulkQr","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await bulkQr({\n    \"body\": {\n        \"color\": \"FF5733\",\n        \"backgroundColor\": \"FF5733\",\n        \"size\": 10,\n        \"type\": \"png\",\n        \"useDomainSettings\": true,\n        \"noExcavate\": false,\n        \"linkIds\": [\n            \"lnk_1A2b_3Cd4Ef5Gh\"\n        ],\n        \"domainId\": \"12345\"\n    }\n});\n"}]}},"/links/{link_id}":{"delete":{"summary":"Delete link","tags":["Link Management"],"description":"Delete link by id\n\n**Rate limit**: 20/s","parameters":[{"schema":{"type":"string","pattern":"lnk_[0-9a-zA-Z]+_[0-9a-zA-Z]+"},"example":"lnk_abc123_abcdef","in":"path","name":"link_id","required":true,"description":"Link ID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the operation succeeded","example":true},"idString":{"type":"string","pattern":"lnk_[0-9a-zA-Z]+_[0-9a-zA-Z]+","description":"Link ID","example":"lnk_abc123_abcdef"},"error":{"type":"string","description":"Error message when operation failed"}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","description":"Always false on error","example":false},"error":{"type":"string","description":"Bad request error message"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","description":"Always false on error","example":false},"error":{"type":"string","description":"Unauthorized error message"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","description":"Always false on error","example":false},"error":{"type":"string","description":"Payment required error message"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","description":"Always false on error","example":false},"error":{"type":"string","description":"Access denied error message"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","description":"Always false on error","example":false},"error":{"type":"string","description":"Not found error message"}}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","description":"Always false on error","example":false},"error":{"type":"string","description":"Conflict error message"}}}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","description":"Always false on error","example":false},"error":{"type":"string","description":"Internal server error message"}}}}}}},"operationId":"deleteLink","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await deleteLink({\n    \"path\": {\n        \"link_id\": \"lnk_abc123_abcdef\"\n    }\n});\n"}]}},"/links/delete_bulk":{"delete":{"summary":"Delete links in bulk","tags":["Link Management"],"description":"Delete links in bulk by ids\n\n**Rate limit**: 1/s","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["link_ids"],"properties":{"link_ids":{"type":"array","items":{"type":"string","pattern":"lnk_[0-9a-zA-Z]+_[0-9a-zA-Z]+","description":"Link ID","example":"lnk_abc123_abcdef"},"maxItems":150,"description":"Encoded link IDs to delete"}}}}},"required":true},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the operation succeeded","example":true},"error":{"type":"string","description":"Error message when operation failed"}}}}}}},"operationId":"deleteDeleteBulk","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await deleteDeleteBulk({\n    \"body\": {\n        \"link_ids\": [\n            \"lnk_abc123_abcdef\"\n        ]\n    }\n});\n"}]}},"/links/archive":{"post":{"summary":"Archive link","tags":["Link Management"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["link_id"],"properties":{"link_id":{"type":"string","description":"Numeric link ID or encoded link ID string","example":"lnk_1A2b_3Cd4Ef5Gh"},"domain_id":{"type":"string","description":"Domain ID, required only when using a legacy numeric link ID","example":"12345"}}}}},"required":true},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the operation succeeded","example":true},"error":{"type":"string","description":"Error message when operation failed"}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Bad request error code or message"},"message":{"type":"string","description":"Additional detail for the error"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Unauthorized error message"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Payment required error message"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Access denied error message"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Not found error message"}}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Conflict error message"}}}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Internal server error message"}}}}}}},"operationId":"archiveLink","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await archiveLink({\n    \"body\": {\n        \"link_id\": \"lnk_1A2b_3Cd4Ef5Gh\",\n        \"domain_id\": \"12345\"\n    }\n});\n"}]}},"/links/archive_bulk":{"post":{"summary":"Archive links in bulk","tags":["Link Management"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["link_ids"],"properties":{"link_ids":{"type":"array","items":{"type":"string","description":"Numeric link ID or encoded link ID string","example":"lnk_1A2b_3Cd4Ef5Gh"},"maxItems":150,"description":"Link IDs to operate on"},"domain_id":{"type":"string","description":"Domain ID, required only when using legacy numeric link IDs","example":"12345"}}}}},"required":true},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the operation succeeded","example":true},"error":{"type":"string","description":"Error message when operation failed"}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Bad request error code or message"},"message":{"type":"string","description":"Additional detail for the error"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Unauthorized error message"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Payment required error message"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Access denied error message"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Not found error message"},"message":{"type":"string","description":"Additional detail for the error"}}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Conflict error message"}}}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Internal server error message"},"message":{"type":"string","description":"Additional detail for the error"}}}}}}},"operationId":"createArchiveBulk","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await createArchiveBulk({\n    \"body\": {\n        \"link_ids\": [\n            \"lnk_1A2b_3Cd4Ef5Gh\"\n        ],\n        \"domain_id\": \"12345\"\n    }\n});\n"}]}},"/links/unarchive":{"post":{"summary":"Unarchive link","tags":["Link Management"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["link_id"],"properties":{"link_id":{"type":"string","description":"Numeric link ID or encoded link ID string","example":"lnk_1A2b_3Cd4Ef5Gh"},"domain_id":{"type":"string","description":"Domain ID, required only when using a legacy numeric link ID","example":"12345"}}}}},"required":true},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the operation succeeded","example":true},"error":{"type":"string","description":"Error message when operation failed"}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Bad request error code or message"},"message":{"type":"string","description":"Additional detail for the error"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Unauthorized error message"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Payment required error message"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Access denied error message"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Not found error message"},"message":{"type":"string","description":"Additional detail for the error"}}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Conflict error message"}}}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Internal server error message"}}}}}}},"operationId":"unarchiveLink","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await unarchiveLink({\n    \"body\": {\n        \"link_id\": \"lnk_1A2b_3Cd4Ef5Gh\",\n        \"domain_id\": \"12345\"\n    }\n});\n"}]}},"/links/unarchive_bulk":{"post":{"summary":"Unarchive links in bulk","tags":["Link Management"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["link_ids"],"properties":{"link_ids":{"type":"array","items":{"type":"string","description":"Numeric link ID or encoded link ID string","example":"lnk_1A2b_3Cd4Ef5Gh"},"maxItems":150,"description":"Link IDs to operate on"},"domain_id":{"type":"string","description":"Domain ID, required only when using legacy numeric link IDs","example":"12345"}}}}},"required":true},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the operation succeeded","example":true},"error":{"type":"string","description":"Error message when operation failed"}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Bad request error code or message"},"message":{"type":"string","description":"Additional detail for the error"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Unauthorized error message"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Payment required error message"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Access denied error message"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Not found error message"}}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Conflict error message"}}}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Internal server error message"}}}}}}},"operationId":"createUnarchiveBulk","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await createUnarchiveBulk({\n    \"body\": {\n        \"link_ids\": [\n            \"lnk_1A2b_3Cd4Ef5Gh\"\n        ],\n        \"domain_id\": \"12345\"\n    }\n});\n"}]}},"/links/{linkId}":{"post":{"summary":"Update existing URL","tags":["Link Management"],"description":"Update original url, title or path for existing URL by id\n\n**Rate limit**: 20/s","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cloaking":{"type":"boolean","description":"Cloaking"},"password":{"type":"string","description":"Link password","example":"s3cur3p@ssw0rd"},"redirectType":{"type":"integer","enum":[301,302,307,308],"description":"HTTP code for redirect","nullable":true,"example":301},"expiresAt":{"anyOf":[{"type":"integer","nullable":true},{"type":"string","format":"iso-date-time","nullable":true}],"description":"Link expiration date in milliseconds or ISO string","example":"2026-04-18T11:06:05.347Z"},"expiredURL":{"type":"string","nullable":true,"description":"Expired URL","example":"https://example.com/expired"},"title":{"type":"string","description":"Link title"},"tags":{"type":"array","items":{"type":"string"},"description":"Array of link tags"},"utmSource":{"type":"string","description":"set utm_source parameter to destination link","example":"cpc"},"utmMedium":{"type":"string","description":"set utm_medium parameter to destination link","example":"banner"},"utmCampaign":{"type":"string","description":"set utm_campaign parameter to destination link","example":"summer_sale"},"utmTerm":{"type":"string","description":"set utm_term parameter to destination link","example":"running_shoes"},"utmContent":{"type":"string","description":"set utm_content parameter to destination link","example":"cta_button"},"ttl":{"anyOf":[{"type":"string","format":"iso-date-time","nullable":true},{"type":"integer","nullable":true}],"description":"Time to live in milliseconds or ISO string","example":"2026-04-18T11:06:05.349Z"},"path":{"type":"string","nullable":true,"description":"Link slug. For case-insensitive domains, the path is normalized to lowercase and the original value is preserved in displayPath.","example":"my-link"},"androidURL":{"type":"string","description":"Android URL","nullable":true,"example":"https://play.google.com/store/apps/details?id=com.example.app"},"iphoneURL":{"type":"string","description":"iPhone URL","nullable":true,"example":"https://apps.apple.com/us/app/example-app/id1234567890"},"createdAt":{"anyOf":[{"type":"integer","nullable":true,"examples":[1776510365349]},{"type":"string","format":"iso-date-time","nullable":true}],"description":"Link creation date in milliseconds","example":"2026-04-18T11:06:05.349Z"},"clicksLimit":{"type":"integer","nullable":true,"minimum":1,"description":"disable link after specified number of clicks","example":100},"passwordContact":{"type":"boolean","description":"Provide your email to users to get a password","nullable":true},"skipQS":{"type":"boolean","description":"Skip query string merging"},"archived":{"type":"boolean","description":"Link is archived","default":false},"splitURL":{"type":"string","description":"Split URL","nullable":true,"example":"https://example.com/split"},"splitPercent":{"type":"integer","nullable":true,"minimum":1,"maximum":100,"description":"Split URL percentage","example":50},"splitURLV2":{"type":"array","items":{"type":"object","required":["url","percent"],"properties":{"percent":{"type":"integer","minimum":1,"maximum":100,"description":"Traffic percentage"}}},"description":"Split URL configurations for multi-way A/B testing","maxItems":10,"nullable":true},"integrationAdroll":{"type":"string","description":"Adroll integration","nullable":true},"integrationFB":{"type":"string","description":"Facebook integration","nullable":true},"integrationTT":{"type":"string","description":"TikTok integration","nullable":true},"integrationGA":{"type":"string","description":"Google Analytics integration","nullable":true},"integrationGTM":{"type":"string","description":"Google Tag Manager integration","nullable":true},"originalURL":{"type":"string","description":"Original URL"}}}}}},"parameters":[{"schema":{"type":"string"},"example":"12345","in":"query","name":"domain_id","required":false,"description":"Domain ID, required only when using a legacy numeric link ID"},{"schema":{"type":"string","pattern":"lnk_\\w+|\\d+"},"example":"lnk_1A2b_3Cd4Ef5Gh","in":"path","name":"linkId","required":true,"description":"Numeric link ID or encoded link ID string"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["originalURL"],"properties":{"originalURL":{"type":"string","url":"destination","description":"Original URL","examples":["https://example.com"]},"cloaking":{"type":"boolean","description":"Cloaking"},"password":{"type":"string","description":"Link password","examples":["s3cur3p@ssw0rd"]},"expiresAt":{"anyOf":[{"type":"integer","nullable":true},{"type":"string","format":"iso-date-time","nullable":true}],"description":"Link expiration date in milliseconds or ISO string","examples":["2026-04-18T11:06:05.347Z"]},"expiredURL":{"type":"string","nullable":true,"url":"destination","description":"Expired URL","examples":["https://example.com/expired"]},"title":{"type":"string","description":"Link title"},"tags":{"type":"array","items":{"type":"string"},"description":"Array of link tags"},"utmSource":{"type":"string","description":"set utm_source parameter to destination link","examples":["cpc","organic"]},"utmMedium":{"type":"string","description":"set utm_medium parameter to destination link","examples":["banner","email"]},"utmCampaign":{"type":"string","description":"set utm_campaign parameter to destination link","examples":["summer_sale"]},"utmTerm":{"type":"string","description":"set utm_term parameter to destination link","examples":["running_shoes"]},"utmContent":{"type":"string","description":"set utm_content parameter to destination link","examples":["cta_button"]},"ttl":{"anyOf":[{"type":"string","format":"iso-date-time","nullable":true},{"type":"integer","nullable":true}],"description":"Time to live in milliseconds or ISO string","examples":["2026-04-18T11:06:05.349Z"]},"androidURL":{"type":"string","url":"destination","description":"Android URL","nullable":true,"examples":["https://play.google.com/store/apps/details?id=com.example.app"]},"iphoneURL":{"type":"string","url":"destination","description":"iPhone URL","nullable":true,"examples":["https://apps.apple.com/us/app/example-app/id1234567890"]},"clicksLimit":{"type":"integer","nullable":true,"minimum":1,"description":"disable link after specified number of clicks","examples":[100]},"passwordContact":{"type":"boolean","description":"Provide your email to users to get a password","nullable":true},"skipQS":{"type":"boolean","description":"Skip query string merging","default":false},"archived":{"type":"boolean","description":"Link is archived","default":false},"splitURL":{"type":"string","url":"destination","description":"Split URL","nullable":true,"examples":["https://example.com/split"]},"splitPercent":{"type":"integer","nullable":true,"minimum":1,"maximum":100,"description":"Split URL percentage","examples":[50]},"splitURLV2":{"type":"array","items":{"type":"object","required":["url","percent"],"properties":{"url":{"type":"string","url":"destination","description":"Split URL destination"},"percent":{"type":"integer","minimum":1,"maximum":100,"description":"Traffic percentage"}}},"description":"Split URL configurations for multi-way A/B testing","maxItems":10,"nullable":true},"integrationAdroll":{"type":"string","description":"Adroll integration","nullable":true},"integrationFB":{"type":"string","description":"Facebook integration","nullable":true},"integrationTT":{"type":"string","description":"TikTok integration","nullable":true},"integrationGA":{"type":"string","description":"Google Analytics integration","nullable":true},"integrationGTM":{"type":"string","description":"Google Tag Manager integration","nullable":true}}},{"type":"object","required":["idString","id","shortURL","secureShortURL","path","displayPath","createdAt","updatedAt"],"properties":{"idString":{"type":"string","description":"Link ID"},"id":{"type":"string","description":"Link ID"},"shortURL":{"type":"string","url":"short","description":"Short URL","examples":["https://short.gy/abc123"]},"secureShortURL":{"type":"string","url":"short","description":"Secure short URL","examples":["https://short.gy/abc123"]},"path":{"anyOf":[{"type":"string","description":"Link slug. For case-insensitive domains, this is the normalized lowercase version of the path.","examples":["my-link"]},{"type":"null"}]},"displayPath":{"anyOf":[{"type":"string","description":"Original path preserving the case as provided during creation. Set only for case-insensitive domains when the path contains uppercase characters, otherwise null.","examples":["My-Link"]},{"type":"null"}]},"redirectType":{"type":"string","description":"HTTP code for redirect","enum":["301","302","307","308"]},"createdAt":{"anyOf":[{"type":"string","format":"iso-date-time"},{"type":"null"}],"description":"Link creation date in ISO format"},"updatedAt":{"anyOf":[{"type":"string","format":"iso-date-time"},{"type":"null"}],"description":"Link last update date in ISO format"},"FolderId":{"anyOf":[{"type":"string","description":"Folder ID","examples":["abc123"]},{"type":"null"}]},"DomainId":{"type":"integer","description":"Domain ID","examples":[1]},"OwnerId":{"type":"integer","description":"Owner ID","examples":[1]},"hasPassword":{"type":"boolean","description":"Link has password","default":false},"source":{"enum":["website","api","public","spreadsheets","slack","telegram",""],"description":"Link source","examples":["api"]},"User":{"anyOf":[{"type":"object","required":["id","name","email","photoURL"],"properties":{"id":{"type":"integer","description":"Creator user ID","examples":[123]},"name":{"anyOf":[{"type":"string","description":"Creator name","examples":["John Doe"]},{"type":"null"}]},"email":{"type":"string","description":"Creator email","examples":["a@example.com"]},"photoURL":{"anyOf":[{"type":"string","description":"User photo URL","examples":["https://example.com/photo.jpg"]},{"type":"null"}]}}},{"type":"null"}]}}}]}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Bad request error message"},"field":{"type":"string","description":"Field that failed validation","example":"path"},"linkId":{"type":"string","description":"Link ID related to the error","example":"lnk_1A2b_3Cd4Ef5Gh"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Unauthorized error message"},"field":{"type":"string","description":"Field that failed validation","example":"path"},"linkId":{"type":"string","description":"Link ID related to the error","example":"lnk_1A2b_3Cd4Ef5Gh"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Payment required error message"},"field":{"type":"string","description":"Field that failed validation","example":"path"},"linkId":{"type":"string","description":"Link ID related to the error","example":"lnk_1A2b_3Cd4Ef5Gh"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Access denied error message"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Not found error message"}}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Conflict error message"},"field":{"type":"string","description":"Field that triggered the conflict","example":"path"},"linkId":{"type":"string","description":"Existing link ID that caused the conflict","example":"lnk_1A2b_3Cd4Ef5Gh"}}}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Internal server error message"}}}}}}},"operationId":"createLink","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await createLink({\n    \"path\": {\n        \"linkId\": \"lnk_1A2b_3Cd4Ef5Gh\"\n    },\n    \"query\": {\n        \"domain_id\": \"12345\"\n    },\n    \"body\": {\n        \"cloaking\": true,\n        \"password\": \"<redacted>\",\n        \"redirectType\": 301,\n        \"expiresAt\": \"2026-04-18T11:06:05.347Z\",\n        \"expiredURL\": \"https://example.com/expired\",\n        \"title\": \"string\",\n        \"tags\": [\n            \"string\"\n        ],\n        \"utmSource\": \"cpc\",\n        \"utmMedium\": \"banner\",\n        \"utmCampaign\": \"summer_sale\",\n        \"utmTerm\": \"running_shoes\",\n        \"utmContent\": \"cta_button\",\n        \"ttl\": \"2026-04-18T11:06:05.349Z\",\n        \"path\": \"my-link\",\n        \"androidURL\": \"https://play.google.com/store/apps/details?id=com.example.app\",\n        \"iphoneURL\": \"https://apps.apple.com/us/app/example-app/id1234567890\",\n        \"createdAt\": \"2026-04-18T11:06:05.349Z\",\n        \"clicksLimit\": 100,\n        \"passwordContact\": true,\n        \"skipQS\": true,\n        \"archived\": false,\n        \"splitURL\": \"https://example.com/split\",\n        \"splitPercent\": 50,\n        \"splitURLV2\": [\n            {\n                \"percent\": 0\n            }\n        ],\n        \"integrationAdroll\": \"string\",\n        \"integrationFB\": \"string\",\n        \"integrationTT\": \"string\",\n        \"integrationGA\": \"string\",\n        \"integrationGTM\": \"string\",\n        \"originalURL\": \"string\"\n    }\n});\n"}]},"get":{"summary":"Get link info by link id","tags":["Link queries"],"description":"Get link info by link id. Rate limit: 20/s","parameters":[{"schema":{"type":"string"},"in":"query","name":"domainId","required":false,"description":"[DEPRECATED] Domain ID"},{"schema":{"type":"string","pattern":"lnk_\\w+|\\d+"},"example":"lnk_1A2b_3Cd4Ef5Gh","in":"path","name":"linkId","required":true,"description":"Numeric link ID or encoded link ID string"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["originalURL"],"properties":{"originalURL":{"type":"string","url":"destination","description":"Original URL","examples":["https://example.com"]},"cloaking":{"type":"boolean","description":"Cloaking"},"password":{"type":"string","description":"Link password","examples":["s3cur3p@ssw0rd"]},"expiresAt":{"anyOf":[{"type":"integer","nullable":true},{"type":"string","format":"iso-date-time","nullable":true}],"description":"Link expiration date in milliseconds or ISO string","examples":["2026-04-18T11:06:05.347Z"]},"expiredURL":{"type":"string","nullable":true,"url":"destination","description":"Expired URL","examples":["https://example.com/expired"]},"title":{"type":"string","description":"Link title"},"tags":{"type":"array","items":{"type":"string"},"description":"Array of link tags"},"utmSource":{"type":"string","description":"set utm_source parameter to destination link","examples":["cpc","organic"]},"utmMedium":{"type":"string","description":"set utm_medium parameter to destination link","examples":["banner","email"]},"utmCampaign":{"type":"string","description":"set utm_campaign parameter to destination link","examples":["summer_sale"]},"utmTerm":{"type":"string","description":"set utm_term parameter to destination link","examples":["running_shoes"]},"utmContent":{"type":"string","description":"set utm_content parameter to destination link","examples":["cta_button"]},"ttl":{"anyOf":[{"type":"string","format":"iso-date-time","nullable":true},{"type":"integer","nullable":true}],"description":"Time to live in milliseconds or ISO string","examples":["2026-04-18T11:06:05.349Z"]},"androidURL":{"type":"string","url":"destination","description":"Android URL","nullable":true,"examples":["https://play.google.com/store/apps/details?id=com.example.app"]},"iphoneURL":{"type":"string","url":"destination","description":"iPhone URL","nullable":true,"examples":["https://apps.apple.com/us/app/example-app/id1234567890"]},"clicksLimit":{"type":"integer","nullable":true,"minimum":1,"description":"disable link after specified number of clicks","examples":[100]},"passwordContact":{"type":"boolean","description":"Provide your email to users to get a password","nullable":true},"skipQS":{"type":"boolean","description":"Skip query string merging","default":false},"archived":{"type":"boolean","description":"Link is archived","default":false},"splitURL":{"type":"string","url":"destination","description":"Split URL","nullable":true,"examples":["https://example.com/split"]},"splitPercent":{"type":"integer","nullable":true,"minimum":1,"maximum":100,"description":"Split URL percentage","examples":[50]},"splitURLV2":{"type":"array","items":{"type":"object","required":["url","percent"],"properties":{"url":{"type":"string","url":"destination","description":"Split URL destination"},"percent":{"type":"integer","minimum":1,"maximum":100,"description":"Traffic percentage"}}},"description":"Split URL configurations for multi-way A/B testing","maxItems":10,"nullable":true},"integrationAdroll":{"type":"string","description":"Adroll integration","nullable":true},"integrationFB":{"type":"string","description":"Facebook integration","nullable":true},"integrationTT":{"type":"string","description":"TikTok integration","nullable":true},"integrationGA":{"type":"string","description":"Google Analytics integration","nullable":true},"integrationGTM":{"type":"string","description":"Google Tag Manager integration","nullable":true}}},{"type":"object","required":["idString","id","shortURL","secureShortURL","path","displayPath","createdAt","updatedAt"],"properties":{"idString":{"type":"string","description":"Link ID"},"id":{"type":"string","description":"Link ID"},"shortURL":{"type":"string","url":"short","description":"Short URL","examples":["https://short.gy/abc123"]},"secureShortURL":{"type":"string","url":"short","description":"Secure short URL","examples":["https://short.gy/abc123"]},"path":{"anyOf":[{"type":"string","description":"Link slug. For case-insensitive domains, this is the normalized lowercase version of the path.","examples":["my-link"]},{"type":"null"}]},"displayPath":{"anyOf":[{"type":"string","description":"Original path preserving the case as provided during creation. Set only for case-insensitive domains when the path contains uppercase characters, otherwise null.","examples":["My-Link"]},{"type":"null"}]},"redirectType":{"type":"string","description":"HTTP code for redirect","enum":["301","302","307","308"]},"createdAt":{"anyOf":[{"type":"string","format":"iso-date-time"},{"type":"null"}],"description":"Link creation date in ISO format"},"updatedAt":{"anyOf":[{"type":"string","format":"iso-date-time"},{"type":"null"}],"description":"Link last update date in ISO format"},"FolderId":{"anyOf":[{"type":"string","description":"Folder ID","examples":["abc123"]},{"type":"null"}]},"DomainId":{"type":"integer","description":"Domain ID","examples":[1]},"OwnerId":{"type":"integer","description":"Owner ID","examples":[1]},"hasPassword":{"type":"boolean","description":"Link has password","default":false},"source":{"enum":["website","api","public","spreadsheets","slack","telegram",""],"description":"Link source","examples":["api"]},"User":{"anyOf":[{"type":"object","required":["id","name","email","photoURL"],"properties":{"id":{"type":"integer","description":"Creator user ID","examples":[123]},"name":{"anyOf":[{"type":"string","description":"Creator name","examples":["John Doe"]},{"type":"null"}]},"email":{"type":"string","description":"Creator email","examples":["a@example.com"]},"photoURL":{"anyOf":[{"type":"string","description":"User photo URL","examples":["https://example.com/photo.jpg"]},{"type":"null"}]}}},{"type":"null"}]}}}]}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Bad request error message"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Access denied error message"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Not found error message"}}}}}}},"operationId":"getLink","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await getLink({\n    \"path\": {\n        \"linkId\": \"lnk_1A2b_3Cd4Ef5Gh\"\n    },\n    \"query\": {\n        \"domainId\": \"string\"\n    }\n});\n"}]}},"/links/expand":{"get":{"summary":"Get link info by path","tags":["Link queries"],"description":"Get link info by path. Rate limit: 20/s","parameters":[{"schema":{"type":"string"},"in":"query","name":"domain","required":true,"description":"Domain hostname"},{"schema":{"type":"string"},"in":"query","name":"path","required":true,"description":"Link path"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["originalURL"],"properties":{"originalURL":{"type":"string","url":"destination","description":"Original URL","examples":["https://example.com"]},"cloaking":{"type":"boolean","description":"Cloaking"},"password":{"type":"string","description":"Link password","examples":["s3cur3p@ssw0rd"]},"expiresAt":{"anyOf":[{"type":"integer","nullable":true},{"type":"string","format":"iso-date-time","nullable":true}],"description":"Link expiration date in milliseconds or ISO string","examples":["2026-04-18T11:06:05.347Z"]},"expiredURL":{"type":"string","nullable":true,"url":"destination","description":"Expired URL","examples":["https://example.com/expired"]},"title":{"type":"string","description":"Link title"},"tags":{"type":"array","items":{"type":"string"},"description":"Array of link tags"},"utmSource":{"type":"string","description":"set utm_source parameter to destination link","examples":["cpc","organic"]},"utmMedium":{"type":"string","description":"set utm_medium parameter to destination link","examples":["banner","email"]},"utmCampaign":{"type":"string","description":"set utm_campaign parameter to destination link","examples":["summer_sale"]},"utmTerm":{"type":"string","description":"set utm_term parameter to destination link","examples":["running_shoes"]},"utmContent":{"type":"string","description":"set utm_content parameter to destination link","examples":["cta_button"]},"ttl":{"anyOf":[{"type":"string","format":"iso-date-time","nullable":true},{"type":"integer","nullable":true}],"description":"Time to live in milliseconds or ISO string","examples":["2026-04-18T11:06:05.349Z"]},"androidURL":{"type":"string","url":"destination","description":"Android URL","nullable":true,"examples":["https://play.google.com/store/apps/details?id=com.example.app"]},"iphoneURL":{"type":"string","url":"destination","description":"iPhone URL","nullable":true,"examples":["https://apps.apple.com/us/app/example-app/id1234567890"]},"clicksLimit":{"type":"integer","nullable":true,"minimum":1,"description":"disable link after specified number of clicks","examples":[100]},"passwordContact":{"type":"boolean","description":"Provide your email to users to get a password","nullable":true},"skipQS":{"type":"boolean","description":"Skip query string merging","default":false},"archived":{"type":"boolean","description":"Link is archived","default":false},"splitURL":{"type":"string","url":"destination","description":"Split URL","nullable":true,"examples":["https://example.com/split"]},"splitPercent":{"type":"integer","nullable":true,"minimum":1,"maximum":100,"description":"Split URL percentage","examples":[50]},"splitURLV2":{"type":"array","items":{"type":"object","required":["url","percent"],"properties":{"url":{"type":"string","url":"destination","description":"Split URL destination"},"percent":{"type":"integer","minimum":1,"maximum":100,"description":"Traffic percentage"}}},"description":"Split URL configurations for multi-way A/B testing","maxItems":10,"nullable":true},"integrationAdroll":{"type":"string","description":"Adroll integration","nullable":true},"integrationFB":{"type":"string","description":"Facebook integration","nullable":true},"integrationTT":{"type":"string","description":"TikTok integration","nullable":true},"integrationGA":{"type":"string","description":"Google Analytics integration","nullable":true},"integrationGTM":{"type":"string","description":"Google Tag Manager integration","nullable":true}}},{"type":"object","required":["idString","id","shortURL","secureShortURL","path","displayPath","createdAt","updatedAt"],"properties":{"idString":{"type":"string","description":"Link ID"},"id":{"type":"string","description":"Link ID"},"shortURL":{"type":"string","url":"short","description":"Short URL","examples":["https://short.gy/abc123"]},"secureShortURL":{"type":"string","url":"short","description":"Secure short URL","examples":["https://short.gy/abc123"]},"path":{"anyOf":[{"type":"string","description":"Link slug. For case-insensitive domains, this is the normalized lowercase version of the path.","examples":["my-link"]},{"type":"null"}]},"displayPath":{"anyOf":[{"type":"string","description":"Original path preserving the case as provided during creation. Set only for case-insensitive domains when the path contains uppercase characters, otherwise null.","examples":["My-Link"]},{"type":"null"}]},"redirectType":{"type":"string","description":"HTTP code for redirect","enum":["301","302","307","308"]},"createdAt":{"anyOf":[{"type":"string","format":"iso-date-time"},{"type":"null"}],"description":"Link creation date in ISO format"},"updatedAt":{"anyOf":[{"type":"string","format":"iso-date-time"},{"type":"null"}],"description":"Link last update date in ISO format"},"FolderId":{"anyOf":[{"type":"string","description":"Folder ID","examples":["abc123"]},{"type":"null"}]},"DomainId":{"type":"integer","description":"Domain ID","examples":[1]},"OwnerId":{"type":"integer","description":"Owner ID","examples":[1]},"hasPassword":{"type":"boolean","description":"Link has password","default":false},"source":{"enum":["website","api","public","spreadsheets","slack","telegram",""],"description":"Link source","examples":["api"]},"User":{"anyOf":[{"type":"object","required":["id","name","email","photoURL"],"properties":{"id":{"type":"integer","description":"Creator user ID","examples":[123]},"name":{"anyOf":[{"type":"string","description":"Creator name","examples":["John Doe"]},{"type":"null"}]},"email":{"type":"string","description":"Creator email","examples":["a@example.com"]},"photoURL":{"anyOf":[{"type":"string","description":"User photo URL","examples":["https://example.com/photo.jpg"]},{"type":"null"}]}}},{"type":"null"}]}}}]}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Bad request error code or message"},"message":{"type":"string","description":"Additional detail for the error"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Not found error message"}}}}}}},"operationId":"expandLink","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await expandLink({\n    \"query\": {\n        \"domain\": \"string\",\n        \"path\": \"string\"\n    }\n});\n"}]}},"/links/by-original-url":{"get":{"summary":"Get link info by original URL","tags":["Link queries"],"description":"**DEPRECATED** Get link info by original URL. Rate limit: 20/s","parameters":[{"schema":{"type":"string"},"in":"query","name":"domain","required":true,"description":"Domain hostname"},{"schema":{"type":"string"},"in":"query","name":"originalURL","required":true,"description":"Link original URL"}],"responses":{"200":{"description":"Default Response"}},"operationId":"listByOriginalUrl","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await listByOriginalUrl({\n    \"query\": {\n        \"domain\": \"string\",\n        \"originalURL\": \"string\"\n    }\n});\n"}]}},"/links/multiple-by-url":{"get":{"summary":"Get links info by original URL","tags":["Link queries"],"description":"Returns all links with the same original URL","parameters":[{"schema":{"type":"string"},"in":"query","name":"domain","required":true,"description":"Domain hostname"},{"schema":{"type":"string"},"in":"query","name":"originalURL","required":true,"description":"Link original URL"}],"responses":{"200":{"description":"Default Response"}},"operationId":"listMultipleByUrl","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await listMultipleByUrl({\n    \"query\": {\n        \"domain\": \"string\",\n        \"originalURL\": \"string\"\n    }\n});\n"}]}},"/links":{"post":{"summary":"Create a new link","tags":["Link Management"],"description":"This method creates a new link. If parameter \"path\" is omitted, it\ngenerates path by algorithm, chosen in domain settings.\n\nNotes:\n\n1. 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\n2. If URL with a given path already exists and originalURL is different from originalURL in database, it returns error with a status `409`\n3. If URL with a given originalURL exists, and no path is given, it returns information about existing URL and does not create anything\n4. If URL with a given originalURL exists, and custom path is given, it creates a new short URL\n\n**Rate limit**: 50/s","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["originalURL"],"properties":{"originalURL":{"type":"string","url":"destination","description":"Original URL","examples":["https://example.com"]},"cloaking":{"type":"boolean","description":"Cloaking"},"password":{"type":"string","description":"Link password","examples":["s3cur3p@ssw0rd"]},"redirectType":{"type":"integer","enum":[301,302,307,308],"description":"HTTP code for redirect","nullable":true,"examples":[301,302]},"expiresAt":{"anyOf":[{"type":"integer","nullable":true},{"type":"string","format":"iso-date-time","nullable":true}],"description":"Link expiration date in milliseconds or ISO string","examples":["2026-04-18T11:06:05.347Z"]},"expiredURL":{"type":"string","nullable":true,"url":"destination","description":"Expired URL","examples":["https://example.com/expired"]},"title":{"type":"string","description":"Link title"},"tags":{"type":"array","items":{"type":"string"},"description":"Array of link tags"},"utmSource":{"type":"string","description":"set utm_source parameter to destination link","examples":["cpc","organic"]},"utmMedium":{"type":"string","description":"set utm_medium parameter to destination link","examples":["banner","email"]},"utmCampaign":{"type":"string","description":"set utm_campaign parameter to destination link","examples":["summer_sale"]},"utmTerm":{"type":"string","description":"set utm_term parameter to destination link","examples":["running_shoes"]},"utmContent":{"type":"string","description":"set utm_content parameter to destination link","examples":["cta_button"]},"ttl":{"anyOf":[{"type":"string","format":"iso-date-time","nullable":true},{"type":"integer","nullable":true}],"description":"Time to live in milliseconds or ISO string","examples":["2026-04-18T11:06:05.349Z"]},"path":{"type":"string","nullable":true,"description":"Link slug. For case-insensitive domains, the path is normalized to lowercase and the original value is preserved in displayPath.","examples":["my-link"]},"androidURL":{"type":"string","url":"destination","description":"Android URL","nullable":true,"examples":["https://play.google.com/store/apps/details?id=com.example.app"]},"iphoneURL":{"type":"string","url":"destination","description":"iPhone URL","nullable":true,"examples":["https://apps.apple.com/us/app/example-app/id1234567890"]},"createdAt":{"anyOf":[{"type":"integer","nullable":true,"examples":[1776510365349]},{"type":"string","format":"iso-date-time","nullable":true}],"description":"Link creation date in milliseconds","examples":["2026-04-18T11:06:05.349Z"]},"clicksLimit":{"type":"integer","nullable":true,"minimum":1,"description":"disable link after specified number of clicks","examples":[100]},"passwordContact":{"type":"boolean","description":"Provide your email to users to get a password","nullable":true},"skipQS":{"type":"boolean","description":"Skip query string merging","default":false},"archived":{"type":"boolean","description":"Link is archived","default":false},"splitURL":{"type":"string","url":"destination","description":"Split URL","nullable":true,"examples":["https://example.com/split"]},"splitPercent":{"type":"integer","nullable":true,"minimum":1,"maximum":100,"description":"Split URL percentage","examples":[50]},"splitURLV2":{"type":"array","items":{"type":"object","required":["url","percent"],"properties":{"url":{"type":"string","url":"destination","description":"Split URL destination"},"percent":{"type":"integer","minimum":1,"maximum":100,"description":"Traffic percentage"}}},"description":"Split URL configurations for multi-way A/B testing","maxItems":10,"nullable":true},"integrationAdroll":{"type":"string","description":"Adroll integration","nullable":true},"integrationFB":{"type":"string","description":"Facebook integration","nullable":true},"integrationTT":{"type":"string","description":"TikTok integration","nullable":true},"integrationGA":{"type":"string","description":"Google Analytics integration","nullable":true},"integrationGTM":{"type":"string","description":"Google Tag Manager integration","nullable":true}}},{"type":"object","required":["domain"],"properties":{"domain":{"type":"string","format":"hostname","description":"Domain hostname"},"allowDuplicates":{"type":"boolean","description":"Allow duplicates","default":false},"folderId":{"type":"string","description":"Folder ID"},"skipQS":{"type":"boolean","description":"Skip query string merging"}}}]}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"type":"object","required":["originalURL"],"properties":{"originalURL":{"type":"string","url":"destination","description":"Original URL","examples":["https://example.com"]},"cloaking":{"type":"boolean","description":"Cloaking"},"password":{"type":"string","description":"Link password","examples":["s3cur3p@ssw0rd"]},"expiresAt":{"anyOf":[{"type":"integer","nullable":true},{"type":"string","format":"iso-date-time","nullable":true}],"description":"Link expiration date in milliseconds or ISO string","examples":["2026-04-18T11:06:05.347Z"]},"expiredURL":{"type":"string","nullable":true,"url":"destination","description":"Expired URL","examples":["https://example.com/expired"]},"title":{"type":"string","description":"Link title"},"tags":{"type":"array","items":{"type":"string"},"description":"Array of link tags"},"utmSource":{"type":"string","description":"set utm_source parameter to destination link","examples":["cpc","organic"]},"utmMedium":{"type":"string","description":"set utm_medium parameter to destination link","examples":["banner","email"]},"utmCampaign":{"type":"string","description":"set utm_campaign parameter to destination link","examples":["summer_sale"]},"utmTerm":{"type":"string","description":"set utm_term parameter to destination link","examples":["running_shoes"]},"utmContent":{"type":"string","description":"set utm_content parameter to destination link","examples":["cta_button"]},"ttl":{"anyOf":[{"type":"string","format":"iso-date-time","nullable":true},{"type":"integer","nullable":true}],"description":"Time to live in milliseconds or ISO string","examples":["2026-04-18T11:06:05.349Z"]},"androidURL":{"type":"string","url":"destination","description":"Android URL","nullable":true,"examples":["https://play.google.com/store/apps/details?id=com.example.app"]},"iphoneURL":{"type":"string","url":"destination","description":"iPhone URL","nullable":true,"examples":["https://apps.apple.com/us/app/example-app/id1234567890"]},"clicksLimit":{"type":"integer","nullable":true,"minimum":1,"description":"disable link after specified number of clicks","examples":[100]},"passwordContact":{"type":"boolean","description":"Provide your email to users to get a password","nullable":true},"skipQS":{"type":"boolean","description":"Skip query string merging","default":false},"archived":{"type":"boolean","description":"Link is archived","default":false},"splitURL":{"type":"string","url":"destination","description":"Split URL","nullable":true,"examples":["https://example.com/split"]},"splitPercent":{"type":"integer","nullable":true,"minimum":1,"maximum":100,"description":"Split URL percentage","examples":[50]},"splitURLV2":{"type":"array","items":{"type":"object","required":["url","percent"],"properties":{"url":{"type":"string","url":"destination","description":"Split URL destination"},"percent":{"type":"integer","minimum":1,"maximum":100,"description":"Traffic percentage"}}},"description":"Split URL configurations for multi-way A/B testing","maxItems":10,"nullable":true},"integrationAdroll":{"type":"string","description":"Adroll integration","nullable":true},"integrationFB":{"type":"string","description":"Facebook integration","nullable":true},"integrationTT":{"type":"string","description":"TikTok integration","nullable":true},"integrationGA":{"type":"string","description":"Google Analytics integration","nullable":true},"integrationGTM":{"type":"string","description":"Google Tag Manager integration","nullable":true}}},{"type":"object","required":["idString","id","shortURL","secureShortURL","path","displayPath","createdAt","updatedAt"],"properties":{"idString":{"type":"string","description":"Link ID"},"id":{"type":"string","description":"Link ID"},"shortURL":{"type":"string","url":"short","description":"Short URL","examples":["https://short.gy/abc123"]},"secureShortURL":{"type":"string","url":"short","description":"Secure short URL","examples":["https://short.gy/abc123"]},"path":{"anyOf":[{"type":"string","description":"Link slug. For case-insensitive domains, this is the normalized lowercase version of the path.","examples":["my-link"]},{"type":"null"}]},"displayPath":{"anyOf":[{"type":"string","description":"Original path preserving the case as provided during creation. Set only for case-insensitive domains when the path contains uppercase characters, otherwise null.","examples":["My-Link"]},{"type":"null"}]},"redirectType":{"type":"string","description":"HTTP code for redirect","enum":["301","302","307","308"]},"createdAt":{"anyOf":[{"type":"string","format":"iso-date-time"},{"type":"null"}],"description":"Link creation date in ISO format"},"updatedAt":{"anyOf":[{"type":"string","format":"iso-date-time"},{"type":"null"}],"description":"Link last update date in ISO format"},"FolderId":{"anyOf":[{"type":"string","description":"Folder ID","examples":["abc123"]},{"type":"null"}]},"DomainId":{"type":"integer","description":"Domain ID","examples":[1]},"OwnerId":{"type":"integer","description":"Owner ID","examples":[1]},"hasPassword":{"type":"boolean","description":"Link has password","default":false},"source":{"enum":["website","api","public","spreadsheets","slack","telegram",""],"description":"Link source","examples":["api"]},"User":{"anyOf":[{"type":"object","required":["id","name","email","photoURL"],"properties":{"id":{"type":"integer","description":"Creator user ID","examples":[123]},"name":{"anyOf":[{"type":"string","description":"Creator name","examples":["John Doe"]},{"type":"null"}]},"email":{"type":"string","description":"Creator email","examples":["a@example.com"]},"photoURL":{"anyOf":[{"type":"string","description":"User photo URL","examples":["https://example.com/photo.jpg"]},{"type":"null"}]}}},{"type":"null"}]}}}]},{"type":"object","properties":{"success":{"type":"boolean","default":true},"duplicate":{"type":"boolean","default":false}}}]}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message","statusCode"],"properties":{"code":{"type":"string","description":"Error code","example":"FST_ERR_VALIDATION"},"message":{"type":"string","description":"Bad request error message"},"success":{"type":"boolean","default":false,"description":"Always false on error","example":false},"statusCode":{"type":"integer","default":400,"description":"HTTP status code","example":400}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message","statusCode"],"properties":{"message":{"type":"string","description":"Unauthorized error message"},"success":{"type":"boolean","default":false,"description":"Always false on error","example":false},"statusCode":{"type":"integer","description":"HTTP status code","example":401}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message","statusCode"],"properties":{"message":{"type":"string","description":"Payment required error message"},"success":{"type":"boolean","default":false,"description":"Always false on error","example":false},"statusCode":{"type":"integer","description":"HTTP status code","example":402}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message","statusCode"],"properties":{"message":{"type":"string","description":"Access denied error message"},"success":{"type":"boolean","default":false,"description":"Always false on error","example":false},"statusCode":{"type":"integer","description":"HTTP status code","example":403}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message","statusCode"],"properties":{"message":{"type":"string","description":"Not found error message"},"success":{"type":"boolean","default":false,"description":"Always false on error","example":false},"statusCode":{"type":"integer","description":"HTTP status code","example":404}}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message","statusCode"],"properties":{"message":{"type":"string","description":"Conflict error message"},"success":{"type":"boolean","default":false,"description":"Always false on error","example":false},"statusCode":{"type":"integer","description":"HTTP status code","example":409}}}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message","statusCode"],"properties":{"message":{"type":"string","description":"Internal server error message"},"success":{"type":"boolean","default":false,"description":"Always false on error","example":false},"statusCode":{"type":"integer","description":"HTTP status code","example":500}}}}}}},"operationId":"createLink","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await createLink({\n    \"body\": {\n        \"originalURL\": \"https://example.com\",\n        \"cloaking\": true,\n        \"password\": \"<redacted>\",\n        \"redirectType\": 301,\n        \"expiresAt\": \"2026-04-18T11:06:05.347Z\",\n        \"expiredURL\": \"https://example.com/expired\",\n        \"title\": \"string\",\n        \"tags\": [\n            \"string\"\n        ],\n        \"utmSource\": \"cpc\",\n        \"utmMedium\": \"banner\",\n        \"utmCampaign\": \"summer_sale\",\n        \"utmTerm\": \"running_shoes\",\n        \"utmContent\": \"cta_button\",\n        \"ttl\": \"2026-04-18T11:06:05.349Z\",\n        \"path\": \"my-link\",\n        \"androidURL\": \"https://play.google.com/store/apps/details?id=com.example.app\",\n        \"iphoneURL\": \"https://apps.apple.com/us/app/example-app/id1234567890\",\n        \"createdAt\": \"2026-04-18T11:06:05.349Z\",\n        \"clicksLimit\": 100,\n        \"passwordContact\": true,\n        \"skipQS\": true,\n        \"archived\": false,\n        \"splitURL\": \"https://example.com/split\",\n        \"splitPercent\": 50,\n        \"splitURLV2\": [\n            {\n                \"url\": \"string\",\n                \"percent\": 0\n            }\n        ],\n        \"integrationAdroll\": \"string\",\n        \"integrationFB\": \"string\",\n        \"integrationTT\": \"string\",\n        \"integrationGA\": \"string\",\n        \"integrationGTM\": \"string\",\n        \"domain\": \"example.com\",\n        \"allowDuplicates\": false,\n        \"folderId\": \"string\"\n    }\n});\n"}]}},"/links/tweetbot":{"get":{"summary":"Create a new link (simple version)","tags":["Link Management"],"description":"\n                    Simple version of link create endpoint. You can use it if you can not use POST method\n                    **Rate limit**: 50/s\n                ","parameters":[{"schema":{"type":"string","format":"hostname"},"in":"query","name":"domain","required":true,"description":"Domain hostname"},{"schema":{"type":"string"},"in":"query","name":"path","required":false,"description":"Link path"},{"schema":{"type":"string"},"in":"query","name":"originalURL","required":true,"description":"Link original URL"},{"schema":{"type":"string"},"in":"query","name":"title","required":false,"description":"Link title"},{"schema":{"anyOf":[{"type":"string","enum":["1"]},{"type":"string","enum":["0"]},{"type":"boolean","description":"Return only URL"}]},"in":"query","name":"urlOnly","required":false},{"schema":{"type":"string"},"in":"query","name":"apiKey","required":true,"description":"API key"}],"responses":{"200":{"description":"Default Response"}},"operationId":"listTweetbot","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await listTweetbot({\n    \"query\": {\n        \"domain\": \"example.com\",\n        \"path\": \"string\",\n        \"originalURL\": \"string\",\n        \"title\": \"string\",\n        \"urlOnly\": \"1\",\n        \"apiKey\": \"<redacted>\"\n    }\n});\n"}]}},"/links/public":{"post":{"summary":"Create a new link using public API key","tags":["Link Management"],"description":"This method creates a new link. Only this method should be used in client-side applications\n\nIf parameter \"path\" is omitted, it generates path by algorithm, chosen in domain settings.\n\nYou can use it with public API key in your frontend applications (client-side javascript, Android & iPhone apps)\n**Rate limit**: 50/s","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["originalURL","domain"],"properties":{"originalURL":{"type":"string","description":"Original URL","example":"https://example.com"},"cloaking":{"type":"boolean","description":"Cloaking"},"password":{"type":"string","description":"Link password","example":"s3cur3p@ssw0rd"},"redirectType":{"type":"integer","enum":[301,302,307,308],"description":"HTTP code for redirect","nullable":true,"example":301},"expiresAt":{"anyOf":[{"type":"integer","nullable":true},{"type":"string","format":"iso-date-time","nullable":true}],"description":"Link expiration date in milliseconds or ISO string","example":"2026-04-18T11:06:05.347Z"},"expiredURL":{"type":"string","nullable":true,"description":"Expired URL","example":"https://example.com/expired"},"title":{"type":"string","description":"Link title"},"tags":{"type":"array","items":{"type":"string"},"description":"Array of link tags"},"utmSource":{"type":"string","description":"set utm_source parameter to destination link","example":"cpc"},"utmMedium":{"type":"string","description":"set utm_medium parameter to destination link","example":"banner"},"utmCampaign":{"type":"string","description":"set utm_campaign parameter to destination link","example":"summer_sale"},"utmTerm":{"type":"string","description":"set utm_term parameter to destination link","example":"running_shoes"},"utmContent":{"type":"string","description":"set utm_content parameter to destination link","example":"cta_button"},"ttl":{"anyOf":[{"type":"string","format":"iso-date-time","nullable":true},{"type":"integer","nullable":true}],"description":"Time to live in milliseconds or ISO string","example":"2026-04-18T11:06:05.349Z"},"path":{"type":"string","nullable":true,"description":"Link slug. For case-insensitive domains, the path is normalized to lowercase and the original value is preserved in displayPath.","example":"my-link"},"androidURL":{"type":"string","description":"Android URL","nullable":true,"example":"https://play.google.com/store/apps/details?id=com.example.app"},"iphoneURL":{"type":"string","description":"iPhone URL","nullable":true,"example":"https://apps.apple.com/us/app/example-app/id1234567890"},"createdAt":{"anyOf":[{"type":"integer","nullable":true,"examples":[1776510365349]},{"type":"string","format":"iso-date-time","nullable":true}],"description":"Link creation date in milliseconds","example":"2026-04-18T11:06:05.349Z"},"clicksLimit":{"type":"integer","nullable":true,"minimum":1,"description":"disable link after specified number of clicks","example":100},"passwordContact":{"type":"boolean","description":"Provide your email to users to get a password","nullable":true},"skipQS":{"type":"boolean","description":"Skip query string merging","default":false},"archived":{"type":"boolean","description":"Link is archived","default":false},"splitURL":{"type":"string","description":"Split URL","nullable":true,"example":"https://example.com/split"},"splitPercent":{"type":"integer","nullable":true,"minimum":1,"maximum":100,"description":"Split URL percentage","example":50},"splitURLV2":{"type":"array","items":{"type":"object","required":["url","percent"],"properties":{"percent":{"type":"integer","minimum":1,"maximum":100,"description":"Traffic percentage"}}},"description":"Split URL configurations for multi-way A/B testing","maxItems":10,"nullable":true},"integrationAdroll":{"type":"string","description":"Adroll integration","nullable":true},"integrationFB":{"type":"string","description":"Facebook integration","nullable":true},"integrationTT":{"type":"string","description":"TikTok integration","nullable":true},"integrationGA":{"type":"string","description":"Google Analytics integration","nullable":true},"integrationGTM":{"type":"string","description":"Google Tag Manager integration","nullable":true},"domain":{"type":"string","format":"hostname","description":"Domain hostname","example":"short.io"},"folderId":{"type":"string","description":"Folder ID to place the link into","example":"fld_1a2b3c4d"}}}}},"required":true},"parameters":[{"schema":"object","in":"header","name":"type"},{"schema":"Request headers (must include Authorization with public API key)","in":"header","name":"description"},{"schema":{"type":"string"},"in":"header","name":"additionalProperties"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"type":"object","required":["originalURL"],"properties":{"originalURL":{"type":"string","url":"destination","description":"Original URL","examples":["https://example.com"]},"cloaking":{"type":"boolean","description":"Cloaking"},"password":{"type":"string","description":"Link password","examples":["s3cur3p@ssw0rd"]},"expiresAt":{"anyOf":[{"type":"integer","nullable":true},{"type":"string","format":"iso-date-time","nullable":true}],"description":"Link expiration date in milliseconds or ISO string","examples":["2026-04-18T11:06:05.347Z"]},"expiredURL":{"type":"string","nullable":true,"url":"destination","description":"Expired URL","examples":["https://example.com/expired"]},"title":{"type":"string","description":"Link title"},"tags":{"type":"array","items":{"type":"string"},"description":"Array of link tags"},"utmSource":{"type":"string","description":"set utm_source parameter to destination link","examples":["cpc","organic"]},"utmMedium":{"type":"string","description":"set utm_medium parameter to destination link","examples":["banner","email"]},"utmCampaign":{"type":"string","description":"set utm_campaign parameter to destination link","examples":["summer_sale"]},"utmTerm":{"type":"string","description":"set utm_term parameter to destination link","examples":["running_shoes"]},"utmContent":{"type":"string","description":"set utm_content parameter to destination link","examples":["cta_button"]},"ttl":{"anyOf":[{"type":"string","format":"iso-date-time","nullable":true},{"type":"integer","nullable":true}],"description":"Time to live in milliseconds or ISO string","examples":["2026-04-18T11:06:05.349Z"]},"androidURL":{"type":"string","url":"destination","description":"Android URL","nullable":true,"examples":["https://play.google.com/store/apps/details?id=com.example.app"]},"iphoneURL":{"type":"string","url":"destination","description":"iPhone URL","nullable":true,"examples":["https://apps.apple.com/us/app/example-app/id1234567890"]},"clicksLimit":{"type":"integer","nullable":true,"minimum":1,"description":"disable link after specified number of clicks","examples":[100]},"passwordContact":{"type":"boolean","description":"Provide your email to users to get a password","nullable":true},"skipQS":{"type":"boolean","description":"Skip query string merging","default":false},"archived":{"type":"boolean","description":"Link is archived","default":false},"splitURL":{"type":"string","url":"destination","description":"Split URL","nullable":true,"examples":["https://example.com/split"]},"splitPercent":{"type":"integer","nullable":true,"minimum":1,"maximum":100,"description":"Split URL percentage","examples":[50]},"splitURLV2":{"type":"array","items":{"type":"object","required":["url","percent"],"properties":{"url":{"type":"string","url":"destination","description":"Split URL destination"},"percent":{"type":"integer","minimum":1,"maximum":100,"description":"Traffic percentage"}}},"description":"Split URL configurations for multi-way A/B testing","maxItems":10,"nullable":true},"integrationAdroll":{"type":"string","description":"Adroll integration","nullable":true},"integrationFB":{"type":"string","description":"Facebook integration","nullable":true},"integrationTT":{"type":"string","description":"TikTok integration","nullable":true},"integrationGA":{"type":"string","description":"Google Analytics integration","nullable":true},"integrationGTM":{"type":"string","description":"Google Tag Manager integration","nullable":true}}},{"type":"object","required":["idString","id","shortURL","secureShortURL","path","displayPath","createdAt","updatedAt"],"properties":{"idString":{"type":"string","description":"Link ID"},"id":{"type":"string","description":"Link ID"},"shortURL":{"type":"string","url":"short","description":"Short URL","examples":["https://short.gy/abc123"]},"secureShortURL":{"type":"string","url":"short","description":"Secure short URL","examples":["https://short.gy/abc123"]},"path":{"anyOf":[{"type":"string","description":"Link slug. For case-insensitive domains, this is the normalized lowercase version of the path.","examples":["my-link"]},{"type":"null"}]},"displayPath":{"anyOf":[{"type":"string","description":"Original path preserving the case as provided during creation. Set only for case-insensitive domains when the path contains uppercase characters, otherwise null.","examples":["My-Link"]},{"type":"null"}]},"redirectType":{"type":"string","description":"HTTP code for redirect","enum":["301","302","307","308"]},"createdAt":{"anyOf":[{"type":"string","format":"iso-date-time"},{"type":"null"}],"description":"Link creation date in ISO format"},"updatedAt":{"anyOf":[{"type":"string","format":"iso-date-time"},{"type":"null"}],"description":"Link last update date in ISO format"},"FolderId":{"anyOf":[{"type":"string","description":"Folder ID","examples":["abc123"]},{"type":"null"}]},"DomainId":{"type":"integer","description":"Domain ID","examples":[1]},"OwnerId":{"type":"integer","description":"Owner ID","examples":[1]},"hasPassword":{"type":"boolean","description":"Link has password","default":false},"source":{"enum":["website","api","public","spreadsheets","slack","telegram",""],"description":"Link source","examples":["api"]},"User":{"anyOf":[{"type":"object","required":["id","name","email","photoURL"],"properties":{"id":{"type":"integer","description":"Creator user ID","examples":[123]},"name":{"anyOf":[{"type":"string","description":"Creator name","examples":["John Doe"]},{"type":"null"}]},"email":{"type":"string","description":"Creator email","examples":["a@example.com"]},"photoURL":{"anyOf":[{"type":"string","description":"User photo URL","examples":["https://example.com/photo.jpg"]},{"type":"null"}]}}},{"type":"null"}]}}}]},{"type":"object","properties":{"success":{"type":"boolean","default":true},"duplicate":{"type":"boolean","default":false}}}]}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message","statusCode"],"properties":{"code":{"type":"string","description":"Error code","example":"FST_ERR_VALIDATION"},"message":{"type":"string","description":"Bad request error message"},"success":{"type":"boolean","default":false,"description":"Always false on error","example":false},"statusCode":{"type":"integer","default":400,"description":"HTTP status code","example":400}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message","success","statusCode"],"properties":{"message":{"type":"string","description":"Unauthorized error message"},"success":{"type":"boolean","default":false,"description":"Always false on error","example":false},"statusCode":{"type":"integer","default":401,"description":"HTTP status code","example":401}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Payment required error message"},"success":{"type":"boolean","default":false,"description":"Always false on error","example":false}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Access denied error message"},"success":{"type":"boolean","default":false,"description":"Always false on error","example":false}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message","success","statusCode"],"properties":{"message":{"type":"string","description":"Not found error message"},"success":{"type":"boolean","default":false,"description":"Always false on error","example":false},"statusCode":{"type":"integer","default":404,"description":"HTTP status code","example":404}}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Conflict error message"},"success":{"type":"boolean","default":false,"description":"Always false on error","example":false}}}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message","success"],"properties":{"message":{"type":"string","description":"Internal server error message"},"success":{"type":"boolean","default":false,"description":"Always false on error","example":false}}}}}}},"operationId":"createPublic","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await createPublic({\n    \"body\": {\n        \"originalURL\": \"https://example.com\",\n        \"cloaking\": true,\n        \"password\": \"<redacted>\",\n        \"redirectType\": 301,\n        \"expiresAt\": \"2026-04-18T11:06:05.347Z\",\n        \"expiredURL\": \"https://example.com/expired\",\n        \"title\": \"string\",\n        \"tags\": [\n            \"string\"\n        ],\n        \"utmSource\": \"cpc\",\n        \"utmMedium\": \"banner\",\n        \"utmCampaign\": \"summer_sale\",\n        \"utmTerm\": \"running_shoes\",\n        \"utmContent\": \"cta_button\",\n        \"ttl\": \"2026-04-18T11:06:05.349Z\",\n        \"path\": \"my-link\",\n        \"androidURL\": \"https://play.google.com/store/apps/details?id=com.example.app\",\n        \"iphoneURL\": \"https://apps.apple.com/us/app/example-app/id1234567890\",\n        \"createdAt\": \"2026-04-18T11:06:05.349Z\",\n        \"clicksLimit\": 100,\n        \"passwordContact\": true,\n        \"skipQS\": false,\n        \"archived\": false,\n        \"splitURL\": \"https://example.com/split\",\n        \"splitPercent\": 50,\n        \"splitURLV2\": [\n            {\n                \"percent\": 0\n            }\n        ],\n        \"integrationAdroll\": \"string\",\n        \"integrationFB\": \"string\",\n        \"integrationTT\": \"string\",\n        \"integrationGA\": \"string\",\n        \"integrationGTM\": \"string\",\n        \"domain\": \"short.io\",\n        \"folderId\": \"fld_1a2b3c4d\"\n    }\n});\n"}]}},"/links/bulk":{"post":{"summary":"Create up to 1000 links in one call","tags":["Link Management"],"description":"Please use this method if you need to create big packs of links. It\naccepts up to 1000 links in one API call.\n\nIt works almost the same as single link creation endpoint, but accepts\nan array of URLs and returns an array of responses.\n\nReturns list of Link objects. If any URL is failed to insert, it returns\nerror object instead as array element. Method is not transactional – it\ncan insert some links from the list and return an error for others.\n\n**Rate limit**: 5 queries in 10 seconds","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["domain","links"],"properties":{"domain":{"type":"string","format":"hostname","description":"Domain hostname","example":"short.io"},"allowDuplicates":{"type":"boolean","default":false,"description":"Allow duplicate destinations across the batch","example":false},"links":{"type":"array","items":{"allOf":[{"type":"object","properties":{"allowDuplicates":{"type":"boolean","description":"Allow duplicate for this individual link","examples":[false]}}},{"type":"object","required":["originalURL"],"properties":{"originalURL":{"type":"string","url":"destination","description":"Original URL","examples":["https://example.com"]},"cloaking":{"type":"boolean","description":"Cloaking"},"password":{"type":"string","description":"Link password","examples":["s3cur3p@ssw0rd"]},"redirectType":{"type":"integer","enum":[301,302,307,308],"description":"HTTP code for redirect","nullable":true,"examples":[301,302]},"expiresAt":{"anyOf":[{"type":"integer","nullable":true},{"type":"string","format":"iso-date-time","nullable":true}],"description":"Link expiration date in milliseconds or ISO string","examples":["2026-04-18T11:06:05.347Z"]},"expiredURL":{"type":"string","nullable":true,"url":"destination","description":"Expired URL","examples":["https://example.com/expired"]},"title":{"type":"string","description":"Link title"},"tags":{"type":"array","items":{"type":"string"},"description":"Array of link tags"},"utmSource":{"type":"string","description":"set utm_source parameter to destination link","examples":["cpc","organic"]},"utmMedium":{"type":"string","description":"set utm_medium parameter to destination link","examples":["banner","email"]},"utmCampaign":{"type":"string","description":"set utm_campaign parameter to destination link","examples":["summer_sale"]},"utmTerm":{"type":"string","description":"set utm_term parameter to destination link","examples":["running_shoes"]},"utmContent":{"type":"string","description":"set utm_content parameter to destination link","examples":["cta_button"]},"ttl":{"anyOf":[{"type":"string","format":"iso-date-time","nullable":true},{"type":"integer","nullable":true}],"description":"Time to live in milliseconds or ISO string","examples":["2026-04-18T11:06:05.349Z"]},"path":{"type":"string","nullable":true,"description":"Link slug. For case-insensitive domains, the path is normalized to lowercase and the original value is preserved in displayPath.","examples":["my-link"]},"androidURL":{"type":"string","url":"destination","description":"Android URL","nullable":true,"examples":["https://play.google.com/store/apps/details?id=com.example.app"]},"iphoneURL":{"type":"string","url":"destination","description":"iPhone URL","nullable":true,"examples":["https://apps.apple.com/us/app/example-app/id1234567890"]},"createdAt":{"anyOf":[{"type":"integer","nullable":true,"examples":[1776510365349]},{"type":"string","format":"iso-date-time","nullable":true}],"description":"Link creation date in milliseconds","examples":["2026-04-18T11:06:05.349Z"]},"clicksLimit":{"type":"integer","nullable":true,"minimum":1,"description":"disable link after specified number of clicks","examples":[100]},"passwordContact":{"type":"boolean","description":"Provide your email to users to get a password","nullable":true},"skipQS":{"type":"boolean","description":"Skip query string merging","default":false},"archived":{"type":"boolean","description":"Link is archived","default":false},"splitURL":{"type":"string","url":"destination","description":"Split URL","nullable":true,"examples":["https://example.com/split"]},"splitPercent":{"type":"integer","nullable":true,"minimum":1,"maximum":100,"description":"Split URL percentage","examples":[50]},"splitURLV2":{"type":"array","items":{"type":"object","required":["url","percent"],"properties":{"url":{"type":"string","url":"destination","description":"Split URL destination"},"percent":{"type":"integer","minimum":1,"maximum":100,"description":"Traffic percentage"}}},"description":"Split URL configurations for multi-way A/B testing","maxItems":10,"nullable":true},"integrationAdroll":{"type":"string","description":"Adroll integration","nullable":true},"integrationFB":{"type":"string","description":"Facebook integration","nullable":true},"integrationTT":{"type":"string","description":"TikTok integration","nullable":true},"integrationGA":{"type":"string","description":"Google Analytics integration","nullable":true},"integrationGTM":{"type":"string","description":"Google Tag Manager integration","nullable":true}}}]},"description":"Links to create (up to 1000)"},"folderId":{"type":"string","description":"Folder ID"}}}}},"required":true},"responses":{"200":{"description":"Default Response"}},"operationId":"bulkLink","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await bulkLink({\n    \"body\": {\n        \"domain\": \"short.io\",\n        \"allowDuplicates\": false,\n        \"links\": [\n            {\n                \"originalURL\": \"https://example.com\"\n            }\n        ],\n        \"folderId\": \"string\"\n    }\n});\n"}]}},"/links/examples":{"post":{"summary":"Generate example links for a domain","tags":["Link Management"],"description":"Creates a set of demo/example links to showcase various features of the short link service.\n\nExample links include:\n- A/B testing with split URLs\n- Mobile targeting (different URLs for Android/iPhone)\n- Expiring links with time limits\n- File download links\n- Password-protected links\n\n**Rate limit**: 5/10s","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["domain"],"properties":{"domain":{"type":"string","format":"hostname","description":"Domain hostname to create examples for"}}}}},"required":true},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","links"],"properties":{"success":{"type":"boolean","description":"Whether the example links were created","example":true},"links":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","required":["originalURL"],"properties":{"originalURL":{"type":"string","url":"destination","description":"Original URL","examples":["https://example.com"]},"cloaking":{"type":"boolean","description":"Cloaking"},"password":{"type":"string","description":"Link password","examples":["s3cur3p@ssw0rd"]},"expiresAt":{"anyOf":[{"type":"integer","nullable":true},{"type":"string","format":"iso-date-time","nullable":true}],"description":"Link expiration date in milliseconds or ISO string","examples":["2026-04-18T11:06:05.347Z"]},"expiredURL":{"type":"string","nullable":true,"url":"destination","description":"Expired URL","examples":["https://example.com/expired"]},"title":{"type":"string","description":"Link title"},"tags":{"type":"array","items":{"type":"string"},"description":"Array of link tags"},"utmSource":{"type":"string","description":"set utm_source parameter to destination link","examples":["cpc","organic"]},"utmMedium":{"type":"string","description":"set utm_medium parameter to destination link","examples":["banner","email"]},"utmCampaign":{"type":"string","description":"set utm_campaign parameter to destination link","examples":["summer_sale"]},"utmTerm":{"type":"string","description":"set utm_term parameter to destination link","examples":["running_shoes"]},"utmContent":{"type":"string","description":"set utm_content parameter to destination link","examples":["cta_button"]},"ttl":{"anyOf":[{"type":"string","format":"iso-date-time","nullable":true},{"type":"integer","nullable":true}],"description":"Time to live in milliseconds or ISO string","examples":["2026-04-18T11:06:05.349Z"]},"androidURL":{"type":"string","url":"destination","description":"Android URL","nullable":true,"examples":["https://play.google.com/store/apps/details?id=com.example.app"]},"iphoneURL":{"type":"string","url":"destination","description":"iPhone URL","nullable":true,"examples":["https://apps.apple.com/us/app/example-app/id1234567890"]},"clicksLimit":{"type":"integer","nullable":true,"minimum":1,"description":"disable link after specified number of clicks","examples":[100]},"passwordContact":{"type":"boolean","description":"Provide your email to users to get a password","nullable":true},"skipQS":{"type":"boolean","description":"Skip query string merging","default":false},"archived":{"type":"boolean","description":"Link is archived","default":false},"splitURL":{"type":"string","url":"destination","description":"Split URL","nullable":true,"examples":["https://example.com/split"]},"splitPercent":{"type":"integer","nullable":true,"minimum":1,"maximum":100,"description":"Split URL percentage","examples":[50]},"splitURLV2":{"type":"array","items":{"type":"object","required":["url","percent"],"properties":{"url":{"type":"string","url":"destination","description":"Split URL destination"},"percent":{"type":"integer","minimum":1,"maximum":100,"description":"Traffic percentage"}}},"description":"Split URL configurations for multi-way A/B testing","maxItems":10,"nullable":true},"integrationAdroll":{"type":"string","description":"Adroll integration","nullable":true},"integrationFB":{"type":"string","description":"Facebook integration","nullable":true},"integrationTT":{"type":"string","description":"TikTok integration","nullable":true},"integrationGA":{"type":"string","description":"Google Analytics integration","nullable":true},"integrationGTM":{"type":"string","description":"Google Tag Manager integration","nullable":true}}},{"type":"object","required":["idString","id","shortURL","secureShortURL","path","displayPath","createdAt","updatedAt"],"properties":{"idString":{"type":"string","description":"Link ID"},"id":{"type":"string","description":"Link ID"},"shortURL":{"type":"string","url":"short","description":"Short URL","examples":["https://short.gy/abc123"]},"secureShortURL":{"type":"string","url":"short","description":"Secure short URL","examples":["https://short.gy/abc123"]},"path":{"anyOf":[{"type":"string","description":"Link slug. For case-insensitive domains, this is the normalized lowercase version of the path.","examples":["my-link"]},{"type":"null"}]},"displayPath":{"anyOf":[{"type":"string","description":"Original path preserving the case as provided during creation. Set only for case-insensitive domains when the path contains uppercase characters, otherwise null.","examples":["My-Link"]},{"type":"null"}]},"redirectType":{"type":"string","description":"HTTP code for redirect","enum":["301","302","307","308"]},"createdAt":{"anyOf":[{"type":"string","format":"iso-date-time"},{"type":"null"}],"description":"Link creation date in ISO format"},"updatedAt":{"anyOf":[{"type":"string","format":"iso-date-time"},{"type":"null"}],"description":"Link last update date in ISO format"},"FolderId":{"anyOf":[{"type":"string","description":"Folder ID","examples":["abc123"]},{"type":"null"}]},"DomainId":{"type":"integer","description":"Domain ID","examples":[1]},"OwnerId":{"type":"integer","description":"Owner ID","examples":[1]},"hasPassword":{"type":"boolean","description":"Link has password","default":false},"source":{"enum":["website","api","public","spreadsheets","slack","telegram",""],"description":"Link source","examples":["api"]},"User":{"anyOf":[{"type":"object","required":["id","name","email","photoURL"],"properties":{"id":{"type":"integer","description":"Creator user ID","examples":[123]},"name":{"anyOf":[{"type":"string","description":"Creator name","examples":["John Doe"]},{"type":"null"}]},"email":{"type":"string","description":"Creator email","examples":["a@example.com"]},"photoURL":{"anyOf":[{"type":"string","description":"User photo URL","examples":["https://example.com/photo.jpg"]},{"type":"null"}]}}},{"type":"null"}]}}}]},{"type":"object","properties":{"success":{"type":"boolean","default":true},"duplicate":{"type":"boolean","default":false}}}]},"description":"Created example links"}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Bad request error message"},"success":{"type":"boolean","description":"Always false on error","example":false}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Unauthorized error message"},"success":{"type":"boolean","description":"Always false on error","example":false}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Payment required error message"},"success":{"type":"boolean","description":"Always false on error","example":false}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Access denied error message"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Not found error message"}}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Conflict error message"},"success":{"type":"boolean","description":"Always false on error","example":false}}}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Internal server error message"},"success":{"type":"boolean","description":"Always false on error","example":false}}}}}}},"operationId":"createExample","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await createExample({\n    \"body\": {\n        \"domain\": \"example.com\"\n    }\n});\n"}]}},"/links/duplicate/{linkId}":{"post":{"summary":"Duplicate an existing link","tags":["Link Management","Link Duplication"],"description":"Duplicates an existing link with all its properties, targeting rules, and settings.\nThe duplicated link will have a new random path (or custom if provided) and be fully independent.\n\n**Rate limit**: 50/s","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":"string","description":"Custom path for duplicated link","example":"my-link-copy"}}}}}},"parameters":[{"schema":{"type":"string","pattern":"lnk_\\w+_\\w+"},"example":"lnk_1A2b_3Cd4Ef5Gh","in":"path","name":"linkId","required":true,"description":"Encoded link ID string of the source link"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["originalURL"],"properties":{"originalURL":{"type":"string","url":"destination","description":"Original URL","examples":["https://example.com"]},"cloaking":{"type":"boolean","description":"Cloaking"},"password":{"type":"string","description":"Link password","examples":["s3cur3p@ssw0rd"]},"expiresAt":{"anyOf":[{"type":"integer","nullable":true},{"type":"string","format":"iso-date-time","nullable":true}],"description":"Link expiration date in milliseconds or ISO string","examples":["2026-04-18T11:06:05.347Z"]},"expiredURL":{"type":"string","nullable":true,"url":"destination","description":"Expired URL","examples":["https://example.com/expired"]},"title":{"type":"string","description":"Link title"},"tags":{"type":"array","items":{"type":"string"},"description":"Array of link tags"},"utmSource":{"type":"string","description":"set utm_source parameter to destination link","examples":["cpc","organic"]},"utmMedium":{"type":"string","description":"set utm_medium parameter to destination link","examples":["banner","email"]},"utmCampaign":{"type":"string","description":"set utm_campaign parameter to destination link","examples":["summer_sale"]},"utmTerm":{"type":"string","description":"set utm_term parameter to destination link","examples":["running_shoes"]},"utmContent":{"type":"string","description":"set utm_content parameter to destination link","examples":["cta_button"]},"ttl":{"anyOf":[{"type":"string","format":"iso-date-time","nullable":true},{"type":"integer","nullable":true}],"description":"Time to live in milliseconds or ISO string","examples":["2026-04-18T11:06:05.349Z"]},"androidURL":{"type":"string","url":"destination","description":"Android URL","nullable":true,"examples":["https://play.google.com/store/apps/details?id=com.example.app"]},"iphoneURL":{"type":"string","url":"destination","description":"iPhone URL","nullable":true,"examples":["https://apps.apple.com/us/app/example-app/id1234567890"]},"clicksLimit":{"type":"integer","nullable":true,"minimum":1,"description":"disable link after specified number of clicks","examples":[100]},"passwordContact":{"type":"boolean","description":"Provide your email to users to get a password","nullable":true},"skipQS":{"type":"boolean","description":"Skip query string merging","default":false},"archived":{"type":"boolean","description":"Link is archived","default":false},"splitURL":{"type":"string","url":"destination","description":"Split URL","nullable":true,"examples":["https://example.com/split"]},"splitPercent":{"type":"integer","nullable":true,"minimum":1,"maximum":100,"description":"Split URL percentage","examples":[50]},"splitURLV2":{"type":"array","items":{"type":"object","required":["url","percent"],"properties":{"url":{"type":"string","url":"destination","description":"Split URL destination"},"percent":{"type":"integer","minimum":1,"maximum":100,"description":"Traffic percentage"}}},"description":"Split URL configurations for multi-way A/B testing","maxItems":10,"nullable":true},"integrationAdroll":{"type":"string","description":"Adroll integration","nullable":true},"integrationFB":{"type":"string","description":"Facebook integration","nullable":true},"integrationTT":{"type":"string","description":"TikTok integration","nullable":true},"integrationGA":{"type":"string","description":"Google Analytics integration","nullable":true},"integrationGTM":{"type":"string","description":"Google Tag Manager integration","nullable":true}}},{"type":"object","required":["idString","id","shortURL","secureShortURL","path","displayPath","createdAt","updatedAt"],"properties":{"idString":{"type":"string","description":"Link ID"},"id":{"type":"string","description":"Link ID"},"shortURL":{"type":"string","url":"short","description":"Short URL","examples":["https://short.gy/abc123"]},"secureShortURL":{"type":"string","url":"short","description":"Secure short URL","examples":["https://short.gy/abc123"]},"path":{"anyOf":[{"type":"string","description":"Link slug. For case-insensitive domains, this is the normalized lowercase version of the path.","examples":["my-link"]},{"type":"null"}]},"displayPath":{"anyOf":[{"type":"string","description":"Original path preserving the case as provided during creation. Set only for case-insensitive domains when the path contains uppercase characters, otherwise null.","examples":["My-Link"]},{"type":"null"}]},"redirectType":{"type":"string","description":"HTTP code for redirect","enum":["301","302","307","308"]},"createdAt":{"anyOf":[{"type":"string","format":"iso-date-time"},{"type":"null"}],"description":"Link creation date in ISO format"},"updatedAt":{"anyOf":[{"type":"string","format":"iso-date-time"},{"type":"null"}],"description":"Link last update date in ISO format"},"FolderId":{"anyOf":[{"type":"string","description":"Folder ID","examples":["abc123"]},{"type":"null"}]},"DomainId":{"type":"integer","description":"Domain ID","examples":[1]},"OwnerId":{"type":"integer","description":"Owner ID","examples":[1]},"hasPassword":{"type":"boolean","description":"Link has password","default":false},"source":{"enum":["website","api","public","spreadsheets","slack","telegram",""],"description":"Link source","examples":["api"]},"User":{"anyOf":[{"type":"object","required":["id","name","email","photoURL"],"properties":{"id":{"type":"integer","description":"Creator user ID","examples":[123]},"name":{"anyOf":[{"type":"string","description":"Creator name","examples":["John Doe"]},{"type":"null"}]},"email":{"type":"string","description":"Creator email","examples":["a@example.com"]},"photoURL":{"anyOf":[{"type":"string","description":"User photo URL","examples":["https://example.com/photo.jpg"]},{"type":"null"}]}}},{"type":"null"}]}}}]},{"type":"object","properties":{"success":{"type":"boolean","default":true},"duplicate":{"type":"boolean","default":false}}}]},{"type":"object","required":["duplicatedFrom"],"properties":{"duplicatedFrom":{"type":"string","description":"Original link's idString"}}}]}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Bad request error message"},"field":{"type":"string","description":"Field that failed validation","example":"path"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Unauthorized error message"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Payment required error message"},"field":{"type":"string","description":"Field that triggered the plan limit","example":"path"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Access denied error message"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Not found error message"}}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Conflict error message"},"field":{"type":"string","description":"Field that triggered the conflict","example":"path"}}}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Internal server error message"}}}}}}},"operationId":"createDuplicate","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await createDuplicate({\n    \"path\": {\n        \"linkId\": \"lnk_1A2b_3Cd4Ef5Gh\"\n    },\n    \"body\": {\n        \"path\": \"my-link-copy\"\n    }\n});\n"}]}},"/api/domains":{"get":{"summary":"List domains","tags":["Domains"],"description":"Shows all domains of current user","parameters":[{"schema":{"type":"integer","default":100,"minimum":1,"maximum":300},"example":100,"in":"query","name":"limit","required":false,"description":"Maximum number of domains to return"},{"schema":{"type":"integer","default":0,"minimum":0},"example":0,"in":"query","name":"offset","required":false,"description":"Number of domains to skip for pagination"},{"schema":{"type":"boolean"},"example":true,"in":"query","name":"noTeamId","required":false,"description":"Return only personal domains not assigned to a team"},{"schema":{"type":"string"},"example":"example","in":"query","name":"pattern","required":false,"description":"Hostname substring filter"},{"schema":{"type":"number"},"example":42,"in":"query","name":"teamId","required":false,"description":"Filter domains by team ID"},{"schema":"object","in":"header","name":"type"},{"schema":{"type":"string"},"in":"header","name":"additionalProperties"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["id","hostname","unicodeHostname","state","createdAt","updatedAt","hasFavicon","hideReferer","linkType","cloaking","hideVisitorIp","enableAI","httpsLevel","httpsLinks","clientStorage","caseSensitive","incrementCounter","robots","exportEnabled","enableConversionTracking","qrScanTracking","dnsConfigDeprecated","isFavorite"],"properties":{"id":{"type":"integer","description":"Domain ID","minimum":1,"example":12345},"hostname":{"type":"string","format":"hostname"},"unicodeHostname":{"type":"string","format":"fqdn"},"state":{"enum":["extra_records","not_registered","configured","not_configured","registration_pending","not_verified"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"TeamId":{"anyOf":[{"type":"integer"},{"type":"null"}]},"OrganizationId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"hasFavicon":{"type":"boolean"},"segmentKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"hideReferer":{"type":"boolean"},"linkType":{"enum":["increment","random","secure","four-char","eight-char","ten-char"]},"cloaking":{"type":"boolean","description":"Enable cloaking for all links on the domain"},"hideVisitorIp":{"type":"boolean","description":"Don't store visitor IPs in our database"},"enableAI":{"type":"boolean","description":"Enable AI for all links on the domain"},"httpsLevel":{"enum":["none","redirect","hsts"]},"httpsLinks":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"webhookURL":{"anyOf":[{"type":"string","format":"iri"},{"type":"null"}]},"integrationGA":{"anyOf":[{"type":"string"},{"type":"null"}]},"integrationFB":{"anyOf":[{"type":"string"},{"type":"null"}]},"integrationTT":{"anyOf":[{"type":"string"},{"type":"null"}]},"integrationAdroll":{"anyOf":[{"type":"string"},{"type":"null"}]},"integrationGTM":{"anyOf":[{"type":"string"},{"type":"null"}]},"clientStorage":{"anyOf":[{"type":"object","additionalProperties":{}},{"type":"null"}]},"caseSensitive":{"type":"boolean"},"incrementCounter":{"type":"string"},"robots":{"enum":["allow","disallow","noindex"]},"sslCertExpirationDate":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"sslCertInstalledSuccess":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"domainRegistrationId":{"anyOf":[{"type":"integer"},{"type":"null"}]},"UserId":{"type":"integer"},"exportEnabled":{"type":"boolean"},"enableConversionTracking":{"type":"boolean"},"qrScanTracking":{"type":"boolean","default":true},"dnsConfigDeprecated":{"type":"boolean"},"isFavorite":{"type":"boolean","description":"Whether the user marked this domain as favorite","example":true}}}}}}}},"operationId":"listDomain","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await listDomain({\n    \"query\": {\n        \"limit\": 100,\n        \"offset\": 0,\n        \"noTeamId\": true,\n        \"pattern\": \"example\",\n        \"teamId\": 42\n    }\n});\n"}]}},"/domains/{domainId}":{"get":{"summary":"Get domain details by id","tags":["Domains"],"parameters":[{"schema":{"type":"integer","minimum":1},"example":12345,"in":"path","name":"domainId","required":true,"description":"Domain ID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["id","hostname","unicodeHostname","state","createdAt","updatedAt","hasFavicon","hideReferer","linkType","cloaking","hideVisitorIp","enableAI","httpsLevel","httpsLinks","clientStorage","caseSensitive","incrementCounter","robots","exportEnabled","enableConversionTracking","qrScanTracking","dnsConfigDeprecated"],"properties":{"id":{"type":"integer","description":"Domain ID","minimum":1,"examples":[12345]},"hostname":{"type":"string","format":"hostname"},"unicodeHostname":{"type":"string","format":"fqdn"},"state":{"enum":["extra_records","not_registered","configured","not_configured","registration_pending","not_verified"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"TeamId":{"anyOf":[{"type":"integer"},{"type":"null"}]},"OrganizationId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"hasFavicon":{"type":"boolean"},"segmentKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"hideReferer":{"type":"boolean"},"linkType":{"enum":["increment","random","secure","four-char","eight-char","ten-char"]},"cloaking":{"type":"boolean","description":"Enable cloaking for all links on the domain"},"hideVisitorIp":{"type":"boolean","description":"Don't store visitor IPs in our database"},"enableAI":{"type":"boolean","description":"Enable AI for all links on the domain"},"httpsLevel":{"enum":["none","redirect","hsts"]},"httpsLinks":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"webhookURL":{"anyOf":[{"type":"string","format":"iri"},{"type":"null"}]},"integrationGA":{"anyOf":[{"type":"string"},{"type":"null"}]},"integrationFB":{"anyOf":[{"type":"string"},{"type":"null"}]},"integrationTT":{"anyOf":[{"type":"string"},{"type":"null"}]},"integrationAdroll":{"anyOf":[{"type":"string"},{"type":"null"}]},"integrationGTM":{"anyOf":[{"type":"string"},{"type":"null"}]},"clientStorage":{"anyOf":[{"type":"object","additionalProperties":{}},{"type":"null"}]},"caseSensitive":{"type":"boolean"},"incrementCounter":{"type":"string"},"robots":{"enum":["allow","disallow","noindex"]},"sslCertExpirationDate":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"sslCertInstalledSuccess":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"domainRegistrationId":{"anyOf":[{"type":"integer"},{"type":"null"}]},"UserId":{"type":"integer"},"exportEnabled":{"type":"boolean"},"enableConversionTracking":{"type":"boolean"},"qrScanTracking":{"type":"boolean","default":true},"dnsConfigDeprecated":{"type":"boolean"}}},{"type":"object","required":["ipExclusions","userPlan"],"properties":{"ipExclusions":{"type":"array","items":{"type":"string","description":"IP address excluded from click tracking","examples":["192.168.1.1"]},"description":"IP addresses excluded from click tracking"},"userPlan":{"enum":["tiny","hobby","small","standard","large"],"description":"Plan type of the domain owner"}}}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Error message","example":"Access denied"},"type":{"type":"string","description":"Error type identifier","enum":["accessDenied"]}}}}}}},"operationId":"getDomain","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await getDomain({\n    \"path\": {\n        \"domainId\": 12345\n    }\n});\n"}]}},"/domains/settings/{domainId}":{"post":{"summary":"Update domain settings","tags":["Domains"],"description":"Update domain settings","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"httpsLevel":{"enum":["none","redirect","hsts"]},"robots":{"enum":["allow","disallow","noindex"]},"segmentKey":{"type":"string","nullable":true},"linkType":{"enum":["increment","random","secure","four-char","eight-char","ten-char"]},"cloaking":{"type":"boolean","description":"Enable cloaking for all links on the domain"},"hideReferer":{"type":"boolean"},"hideVisitorIp":{"type":"boolean","description":"Don't store visitor IPs in our database"},"httpsLinks":{"type":"boolean","nullable":true,"description":"Set to null to reissue a certificate"},"webhookURL":{"anyOf":[{"type":"string","format":"iri"},{"type":"string","enum":[""]},{"type":"null"}]},"integrationGA":{"type":"string","nullable":true},"integrationFB":{"type":"string","nullable":true},"integrationTT":{"type":"string","nullable":true},"integrationAdroll":{"type":"string","nullable":true},"enableConversionTracking":{"type":"boolean"},"qrScanTracking":{"type":"boolean","default":true},"integrationGTM":{"type":"string","pattern":"^$|G(TM)?-\\w+","nullable":true,"example":"G-1234567"},"clientStorage":{"type":"object","description":"For internal use","additionalProperties":{}},"purgeExpiredLinks":{"type":"boolean","description":"[DEPRECATED] do not use"},"enableAI":{"type":"boolean"},"caseSensitive":{"type":"boolean","description":"Enable case sensitivity for short links"}}}}}},"parameters":[{"schema":{"type":"integer","minimum":1},"example":12345,"in":"path","name":"domainId","required":true,"description":"Domain ID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the operation succeeded","example":true}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Error message","example":"Access denied"},"message":{"type":"string","description":"Additional error details"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Error message","example":"Account is locked"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Error message","example":"Upgrade required"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Error message","example":"Forbidden"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Error message","example":"Not found"}}}}}}},"operationId":"createSetting","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await createSetting({\n    \"path\": {\n        \"domainId\": 12345\n    },\n    \"body\": {\n        \"httpsLevel\": \"none\",\n        \"robots\": \"allow\",\n        \"segmentKey\": \"string\",\n        \"linkType\": \"increment\",\n        \"cloaking\": true,\n        \"hideReferer\": true,\n        \"hideVisitorIp\": true,\n        \"httpsLinks\": true,\n        \"webhookURL\": \"string\",\n        \"integrationGA\": \"string\",\n        \"integrationFB\": \"string\",\n        \"integrationTT\": \"string\",\n        \"integrationAdroll\": \"string\",\n        \"enableConversionTracking\": true,\n        \"qrScanTracking\": true,\n        \"integrationGTM\": \"G-1234567\",\n        \"clientStorage\": {},\n        \"purgeExpiredLinks\": true,\n        \"enableAI\": true,\n        \"caseSensitive\": true\n    }\n});\n"}]}},"/tags/bulk":{"post":{"summary":"Append a single tag to the links in bulk","tags":["Link Management"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["tag","link_ids"],"properties":{"tag":{"type":"string","description":"Tag to append to each link","example":"marketing"},"link_ids":{"type":"array","items":{"type":"string","pattern":"lnk_[0-9a-zA-Z]+_[0-9a-zA-Z]+","description":"Link ID","example":"lnk_abc123_abcdef"},"description":"Link id strings to tag","example":["lnk_1_AbCd","lnk_1_EfGh"]}}}}},"required":true},"responses":{"200":{"description":"Default Response"}},"operationId":"bulkTag","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await bulkTag({\n    \"body\": {\n        \"tag\": \"marketing\",\n        \"link_ids\": [\n            \"lnk_1_AbCd\",\n            \"lnk_1_EfGh\"\n        ]\n    }\n});\n"}]}},"/domains":{"post":{"summary":"Create a domain","tags":["Domains"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["hostname"],"properties":{"hostname":{"type":"string","format":"idn-hostname","description":"Domain hostname","example":"😀.link"},"hideReferer":{"type":"boolean","description":"Strip referer header on redirect","example":true},"linkType":{"enum":["increment","random","secure","four-char","eight-char","ten-char"],"description":"Default link type for the domain"}}}}},"required":true},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["id","hostname","unicodeHostname","state","createdAt","updatedAt","hasFavicon","hideReferer","linkType","cloaking","hideVisitorIp","enableAI","httpsLevel","httpsLinks","clientStorage","caseSensitive","incrementCounter","robots","exportEnabled","enableConversionTracking","qrScanTracking","dnsConfigDeprecated"],"properties":{"id":{"type":"integer","description":"Domain ID","minimum":1,"example":12345},"hostname":{"type":"string","format":"hostname"},"unicodeHostname":{"type":"string","format":"fqdn"},"state":{"enum":["extra_records","not_registered","configured","not_configured","registration_pending","not_verified"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"TeamId":{"anyOf":[{"type":"integer"},{"type":"null"}]},"OrganizationId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"hasFavicon":{"type":"boolean"},"segmentKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"hideReferer":{"type":"boolean"},"linkType":{"enum":["increment","random","secure","four-char","eight-char","ten-char"]},"cloaking":{"type":"boolean","description":"Enable cloaking for all links on the domain"},"hideVisitorIp":{"type":"boolean","description":"Don't store visitor IPs in our database"},"enableAI":{"type":"boolean","description":"Enable AI for all links on the domain"},"httpsLevel":{"enum":["none","redirect","hsts"]},"httpsLinks":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"webhookURL":{"anyOf":[{"type":"string","format":"iri"},{"type":"null"}]},"integrationGA":{"anyOf":[{"type":"string"},{"type":"null"}]},"integrationFB":{"anyOf":[{"type":"string"},{"type":"null"}]},"integrationTT":{"anyOf":[{"type":"string"},{"type":"null"}]},"integrationAdroll":{"anyOf":[{"type":"string"},{"type":"null"}]},"integrationGTM":{"anyOf":[{"type":"string"},{"type":"null"}]},"clientStorage":{"anyOf":[{"type":"object","additionalProperties":{}},{"type":"null"}]},"caseSensitive":{"type":"boolean"},"incrementCounter":{"type":"string"},"robots":{"enum":["allow","disallow","noindex"]},"sslCertExpirationDate":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"sslCertInstalledSuccess":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"domainRegistrationId":{"anyOf":[{"type":"integer"},{"type":"null"}]},"UserId":{"type":"integer"},"exportEnabled":{"type":"boolean"},"enableConversionTracking":{"type":"boolean"},"qrScanTracking":{"type":"boolean","default":true},"dnsConfigDeprecated":{"type":"boolean"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Error message","example":"Domain limit reached for your plan"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Error message","example":"Domain is not available"}}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Error message","example":"Domain already exists"}}}}}}},"operationId":"createDomain","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await createDomain({\n    \"body\": {\n        \"hostname\": \"😀.link\",\n        \"hideReferer\": true,\n        \"linkType\": \"increment\"\n    }\n});\n"}]}},"/links/bundle/templates":{"get":{"summary":"Get bundle templates","tags":["Link Bundles"],"description":"Returns all available bundle templates","responses":{"200":{"description":"Default Response"}},"operationId":"listTemplate","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await listTemplate();\n"}]}},"/links/bundle/{id}":{"get":{"summary":"Get bundle by ID","tags":["Link Bundles"],"description":"Returns bundle details by ULID id","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"Bundle ULID id"}],"responses":{"200":{"description":"Default Response"}},"operationId":"getBundle","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await getBundle({\n    \"path\": {\n        \"id\": \"string\"\n    }\n});\n"}]},"put":{"summary":"Update bundle","tags":["Link Bundles"],"description":"Updates bundle details, social media links, and branding","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"DomainId":{"type":"number","description":"Domain ID the bundle belongs to","example":12345},"TemplateId":{"type":"string","nullable":true,"description":"Template ID"},"title":{"type":"string","nullable":true,"description":"Bundle title"},"description":{"type":"string","nullable":true,"description":"Bundle description"},"logoURL":{"type":"string","nullable":true,"description":"Profile or logo URL"},"backgroundImageURL":{"type":"string","nullable":true,"description":"Background image URL"},"twitterUsername":{"type":"string","nullable":true,"description":"Twitter username (without @)"},"fbUsername":{"type":"string","nullable":true,"description":"Facebook username"},"linkedinCompanyname":{"type":"string","nullable":true,"description":"LinkedIn company name (mutually exclusive with linkedinUsername)"},"linkedinUsername":{"type":"string","nullable":true,"description":"LinkedIn username (mutually exclusive with linkedinCompanyname)"},"instagramUsername":{"type":"string","nullable":true,"description":"Instagram username (without @)"},"whatsappURL":{"type":"string","nullable":true,"description":"WhatsApp URL (must start with whatsapp:// or https://)"},"viberURL":{"type":"string","nullable":true,"description":"Viber URL (must start with viber:// or https://)"},"telegramURL":{"type":"string","nullable":true,"description":"Telegram URL"},"threadsUsername":{"type":"string","nullable":true,"description":"Threads username (without @)"},"mastodonUsername":{"type":"string","nullable":true,"description":"Mastodon username"},"blueskyUsername":{"type":"string","nullable":true,"description":"Bluesky username"},"email":{"type":"string","nullable":true,"format":"email","description":"Contact email address"}}}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"Bundle ULID id"}],"responses":{"200":{"description":"Default Response"}},"operationId":"updateBundle","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await updateBundle({\n    \"path\": {\n        \"id\": \"string\"\n    },\n    \"body\": {\n        \"DomainId\": 12345,\n        \"TemplateId\": \"string\",\n        \"title\": \"string\",\n        \"description\": \"string\",\n        \"logoURL\": \"string\",\n        \"backgroundImageURL\": \"string\",\n        \"twitterUsername\": \"string\",\n        \"fbUsername\": \"string\",\n        \"linkedinCompanyname\": \"string\",\n        \"linkedinUsername\": \"string\",\n        \"instagramUsername\": \"string\",\n        \"whatsappURL\": \"string\",\n        \"viberURL\": \"string\",\n        \"telegramURL\": \"string\",\n        \"threadsUsername\": \"string\",\n        \"mastodonUsername\": \"string\",\n        \"blueskyUsername\": \"string\",\n        \"email\": \"user@example.com\"\n    }\n});\n"}]},"delete":{"summary":"Delete bundle","tags":["Link Bundles"],"description":"Deletes a bundle by ULID id","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"Bundle ULID id"}],"responses":{"200":{"description":"Default Response"}},"operationId":"deleteBundle","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await deleteBundle({\n    \"path\": {\n        \"id\": \"string\"\n    }\n});\n"}]}},"/links/bundle/{id}/photo":{"post":{"summary":"Upload bundle logo","tags":["Link Bundles"],"description":"Uploads a logo image for a bundle","requestBody":{"content":{"application/json":{"schema":{"description":"Raw logo image bytes"}}},"description":"Raw logo image bytes"},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"Bundle ULID id"}],"responses":{"200":{"description":"Default Response"}},"operationId":"createPhoto","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await createPhoto({\n    \"path\": {\n        \"id\": \"string\"\n    }\n});\n"}]}},"/links/bundle/{id}/background-image":{"put":{"summary":"Upload bundle background image","tags":["Link Bundles"],"description":"Uploads a background image for a bundle","requestBody":{"content":{"application/json":{"schema":{"description":"Raw background image bytes"}}},"description":"Raw background image bytes"},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"Bundle ULID id"}],"responses":{"200":{"description":"Default Response"}},"operationId":"updateBackgroundImage","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await updateBackgroundImage({\n    \"path\": {\n        \"id\": \"string\"\n    }\n});\n"}]}},"/links/bundle":{"post":{"summary":"Create bundle","tags":["Link Bundles"],"description":"Creates a new link bundle with customizable template, social media links, and branding","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["DomainId","TemplateId"],"properties":{"DomainId":{"type":"number","description":"Domain ID where the bundle will be created"},"TemplateId":{"type":"string","description":"Template ID from available templates"}}},{"type":"object","properties":{"title":{"type":"string","nullable":true,"description":"Bundle title"},"description":{"type":"string","nullable":true,"description":"Bundle description"},"logoURL":{"type":"string","nullable":true,"description":"Profile or logo URL"},"backgroundImageURL":{"type":"string","nullable":true,"description":"Background image URL"},"twitterUsername":{"type":"string","nullable":true,"description":"Twitter username (without @)"},"fbUsername":{"type":"string","nullable":true,"description":"Facebook username"},"linkedinCompanyname":{"type":"string","nullable":true,"description":"LinkedIn company name (mutually exclusive with linkedinUsername)"},"linkedinUsername":{"type":"string","nullable":true,"description":"LinkedIn username (mutually exclusive with linkedinCompanyname)"},"instagramUsername":{"type":"string","nullable":true,"description":"Instagram username (without @)"},"whatsappURL":{"type":"string","nullable":true,"description":"WhatsApp URL (must start with whatsapp:// or https://)"},"viberURL":{"type":"string","nullable":true,"description":"Viber URL (must start with viber:// or https://)"},"telegramURL":{"type":"string","nullable":true,"description":"Telegram URL"},"threadsUsername":{"type":"string","nullable":true,"description":"Threads username (without @)"},"mastodonUsername":{"type":"string","nullable":true,"description":"Mastodon username"},"blueskyUsername":{"type":"string","nullable":true,"description":"Bluesky username"},"email":{"type":"string","nullable":true,"format":"email","description":"Contact email address"}}}]}}}},"responses":{"200":{"description":"Default Response"}},"operationId":"createBundle","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await createBundle({\n    \"body\": {\n        \"DomainId\": 0,\n        \"TemplateId\": \"string\",\n        \"title\": \"string\",\n        \"description\": \"string\",\n        \"logoURL\": \"string\",\n        \"backgroundImageURL\": \"string\",\n        \"twitterUsername\": \"string\",\n        \"fbUsername\": \"string\",\n        \"linkedinCompanyname\": \"string\",\n        \"linkedinUsername\": \"string\",\n        \"instagramUsername\": \"string\",\n        \"whatsappURL\": \"string\",\n        \"viberURL\": \"string\",\n        \"telegramURL\": \"string\",\n        \"threadsUsername\": \"string\",\n        \"mastodonUsername\": \"string\",\n        \"blueskyUsername\": \"string\",\n        \"email\": \"user@example.com\"\n    }\n});\n"}]}},"/links/bundle/{id}/links":{"get":{"summary":"Get bundle links","tags":["Link Bundles"],"description":"Returns all links in a bundle, ordered by sort order","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"Bundle ULID id"}],"responses":{"200":{"description":"Default Response"}},"operationId":"listLink","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await listLink({\n    \"path\": {\n        \"id\": \"string\"\n    }\n});\n"}]},"post":{"summary":"Add link to bundle","tags":["Link Bundles"],"description":"Adds a short link to a bundle. If the link doesn't exist, it will be created.","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["path","title"],"properties":{"path":{"type":"string","description":"Short link path or full URL"},"title":{"type":"string","description":"Display title for the link"}}}}},"required":true},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"Bundle ULID id"}],"responses":{"200":{"description":"Default Response"}},"operationId":"createLink","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await createLink({\n    \"path\": {\n        \"id\": \"string\"\n    },\n    \"body\": {\n        \"path\": \"string\",\n        \"title\": \"string\"\n    }\n});\n"}]},"patch":{"summary":"Update link sort order","tags":["Link Bundles"],"description":"Updates the sort order of links in a bundle","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["id","sortOrder"],"properties":{"id":{"type":"string","description":"Link template ID"},"sortOrder":{"type":"number","description":"New sort order position"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"Bundle ULID id"}],"responses":{"200":{"description":"Default Response"}},"operationId":"updateLink","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await updateLink({\n    \"path\": {\n        \"id\": \"string\"\n    },\n    \"body\": [\n        {\n            \"id\": \"string\",\n            \"sortOrder\": 0\n        }\n    ]\n});\n"}]}},"/links/bundle/{id}/links/{linkTemplateId}":{"delete":{"summary":"Remove link from bundle","tags":["Link Bundles"],"description":"Removes a link from a bundle by its link template ID","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"Bundle ULID id"},{"schema":{"type":"string"},"in":"path","name":"linkTemplateId","required":true,"description":"Link template ID to remove"}],"responses":{"200":{"description":"Default Response"}},"operationId":"deleteLink","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await deleteLink({\n    \"path\": {\n        \"id\": \"string\",\n        \"linkTemplateId\": \"string\"\n    }\n});\n"}]}},"/links/folders/{domainId}":{"get":{"tags":["Link queries"],"description":"Get links folders for the specified domain id","parameters":[{"schema":{"type":"integer"},"example":12345,"in":"path","name":"domainId","required":true,"description":"Domain ID to list folders for"}],"responses":{"200":{"description":"Default Response"}},"operationId":"getFolder","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await getFolder({\n    \"path\": {\n        \"domainId\": 12345\n    }\n});\n"}]}},"/links/folders/{domainId}/{folderId}":{"get":{"tags":["Link queries"],"description":"Get links folder for the specified domain id and user id","parameters":[{"schema":{"type":"integer"},"example":12345,"in":"path","name":"domainId","required":true,"description":"Domain ID the folder belongs to"},{"schema":{"type":"string"},"example":"fld_1a2b3c4d","in":"path","name":"folderId","required":true,"description":"Folder ID"}],"responses":{"200":{"description":"Default Response"}},"operationId":"getFolder","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await getFolder({\n    \"path\": {\n        \"domainId\": 12345,\n        \"folderId\": \"fld_1a2b3c4d\"\n    }\n});\n"}]}},"/links/folders":{"post":{"tags":["Link queries"],"description":"Create a new folder","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["domainId","name"],"properties":{"domainId":{"type":"integer","description":"Domain ID the folder belongs to","example":12345},"name":{"type":"string","description":"Folder display name","example":"Marketing"},"color":{"type":"string","description":"QR code main hex color","example":"000000"},"backgroundColor":{"type":"string","description":"QR code background hex color","example":"FFFFFF"},"logoUrl":{"type":"string","description":"URL of the QR code center logo","example":"https://shortiougc.com/logo.png"},"logoHeight":{"type":"integer","description":"QR code logo height in pixels","example":60},"logoWidth":{"type":"integer","description":"QR code logo width in pixels","example":60},"ecLevel":{"type":"string","description":"QR code error correction level","example":"M"},"borderRadius":{"type":"integer","description":"QR code border radius in pixels","example":8},"noExcavate":{"type":"boolean","description":"Disable logo excavation (cutout)","example":false},"finderOuterShape":{"type":"string","description":"Shape of the outer finder pattern","example":"square"},"finderInnerShape":{"type":"string","description":"Shape of the inner finder pattern","example":"circle"},"finderColor":{"type":"string","description":"Hex color for finder patterns","example":"000000"},"cornerMode":{"type":"string","description":"Corner rendering mode","example":"rounded"},"labelText":{"type":"string","description":"QR code label text","example":"Scan me"},"labelStyle":{"type":"string","description":"Label placement style","example":"bottom"},"labelColor":{"type":"string","description":"Label text hex color","example":"000000"},"labelBgColor":{"type":"string","description":"Label background hex color","example":"FFFFFF"},"labelFontSize":{"type":"integer","description":"Label font size in pixels","example":14},"labelFontFamily":{"type":"string","description":"Label font family","example":"Inter"},"integrationFB":{"type":"string","description":"Facebook Pixel ID","example":"123456789012345"},"integrationTT":{"type":"string","description":"TikTok Pixel ID","example":"C123456789"},"integrationGA":{"type":"string","description":"Google Analytics ID","example":"G-XXXXXXX"},"integrationGTM":{"type":"string","description":"Google Tag Manager ID","example":"GTM-XXXXXX"},"integrationAdroll":{"type":"string","description":"Adroll pixel ID","example":"ABCDE12345"},"utmCampaign":{"type":"string","description":"Default utm_campaign for folder links","example":"summer_sale"},"utmMedium":{"type":"string","description":"Default utm_medium for folder links","example":"email"},"utmSource":{"type":"string","description":"Default utm_source for folder links","example":"newsletter"},"utmTerm":{"type":"string","description":"Default utm_term for folder links","example":"running_shoes"},"utmContent":{"type":"string","description":"Default utm_content for folder links","example":"cta_button"},"redirectType":{"type":"integer","description":"Default HTTP redirect code for folder links","example":302},"expiresAtDays":{"type":"integer","description":"Default link lifetime in days","example":30},"icon":{"type":"string","description":"Folder icon identifier","example":"folder"},"prefix":{"type":"string","description":"Slug prefix applied to folder links","example":"promo-"}}}}},"required":true},"responses":{"200":{"description":"Default Response"}},"operationId":"createFolder","x-codeSamples":[{"lang":"JavaScript","label":"@short.io/client-node","source":"const { data } = await createFolder({\n    \"body\": {\n        \"domainId\": 12345,\n        \"name\": \"Marketing\",\n        \"color\": \"000000\",\n        \"backgroundColor\": \"FFFFFF\",\n        \"logoUrl\": \"https://shortiougc.com/logo.png\",\n        \"logoHeight\": 60,\n        \"logoWidth\": 60,\n        \"ecLevel\": \"M\",\n        \"borderRadius\": 8,\n        \"noExcavate\": false,\n        \"finderOuterShape\": \"square\",\n        \"finderInnerShape\": \"circle\",\n        \"finderColor\": \"000000\",\n        \"cornerMode\": \"rounded\",\n        \"labelText\": \"Scan me\",\n        \"labelStyle\": \"bottom\",\n        \"labelColor\": \"000000\",\n        \"labelBgColor\": \"FFFFFF\",\n        \"labelFontSize\": 14,\n        \"labelFontFamily\": \"Inter\",\n        \"integrationFB\": \"123456789012345\",\n        \"integrationTT\": \"C123456789\",\n        \"integrationGA\": \"G-XXXXXXX\",\n        \"integrationGTM\": \"GTM-XXXXXX\",\n        \"integrationAdroll\": \"ABCDE12345\",\n        \"utmCampaign\": \"summer_sale\",\n        \"utmMedium\": \"email\",\n        \"utmSource\": \"newsletter\",\n        \"utmTerm\": \"running_shoes\",\n        \"utmContent\": \"cta_button\",\n        \"redirectType\": 302,\n        \"expiresAtDays\": 30,\n        \"icon\": \"folder\",\n        \"prefix\": \"promo-\"\n    }\n});\n"}]}}},"servers":[{"url":"https://api.short.io","description":"API server"}],"security":[{"apiKey":[]}]}