{"openapi":"3.1.0","info":{"title":"Short.io API","version":"1.0.0"},"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{}},"paths":{"/links/opengraph/{domainId}/{linkId}":{"get":{"summary":"Get link opengraph properties","tags":["Link queries"],"parameters":[{"schema":{"type":"number"},"in":"path","name":"domainId","required":true},{"schema":{"type":"string"},"in":"path","name":"linkId","required":true}],"responses":{"200":{"description":"Default Response"}}},"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"},"in":"path","name":"domainId","required":true},{"schema":{"type":"string"},"in":"path","name":"linkId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/link_country/{linkId}":{"get":{"summary":"Get link countries","tags":["Link Targeting"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"domainId","required":false},{"schema":{"type":"string"},"in":"path","name":"linkId","required":true}],"responses":{"200":{"description":"Default Response"}}},"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"}}}}},"required":true},"parameters":[{"schema":{"type":"string"},"in":"query","name":"domainId","required":false},{"schema":{"type":"string"},"in":"path","name":"linkId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/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"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"query","name":"domainId","required":false},{"schema":{"type":"string"},"in":"path","name":"linkId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/link_country/{linkId}/{country}":{"delete":{"summary":"Delete link country","tags":["Link Targeting"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"domainId","required":false},{"schema":{"type":"string"},"in":"path","name":"linkId","required":true},{"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"}}}},"/link_region/{linkId}":{"get":{"summary":"Get link regions","tags":["Link Targeting"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"domainId","required":false},{"schema":{"type":"string"},"in":"path","name":"linkId","required":true}],"responses":{"200":{"description":"Default Response"}}},"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"},"originalURL":{"type":"string","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"},"in":"path","name":"linkId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/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"}}}},"/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"},"originalURL":{"type":"string","example":"https://example.com"}}}}}}},"parameters":[{"schema":{"type":"integer"},"in":"query","name":"domainId","required":false},{"schema":{"type":"string"},"in":"path","name":"linkId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/link_region/{linkId}/{country}/{region}":{"delete":{"summary":"Delete link region by country","tags":["Link Targeting"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"domainId","required":false},{"schema":{"type":"string"},"in":"path","name":"linkId","required":true},{"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"},"in":"path","name":"region","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/links/permissions/{domainId}/{linkId}":{"get":{"summary":"Get link permissions","tags":["Link Management"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"domainId","required":true},{"schema":{"type":"string"},"in":"path","name":"linkId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["id","DomainId","UserId","LinkIdString"],"properties":{"id":{"type":"string"},"DomainId":{"type":"integer"},"UserId":{"type":"integer"},"LinkIdString":{"type":"string"}}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}}}},"/links/permissions/{domainId}/{linkId}/{userId}":{"post":{"summary":"Add link permission","tags":["Link Management"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"domainId","required":true},{"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"},"in":"path","name":"userId","required":true}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["id","DomainId","UserId","LinkIdString"],"properties":{"id":{"type":"string"},"DomainId":{"type":"integer"},"UserId":{"type":"integer"},"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"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}}},"delete":{"summary":"Delete link permissions","tags":["Link Management"],"parameters":[{"schema":{"type":"integer","minimum":1},"in":"path","name":"domainId","required":true},{"schema":{"type":"string"},"in":"path","name":"linkId","required":true},{"schema":{"type":"string"},"in":"path","name":"userId","required":true}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}}}},"/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},"in":"query","name":"limit","required":false},{"schema":{"type":"string"},"in":"query","name":"idString","required":false},{"schema":{"type":"string"},"in":"query","name":"createdAt","required":false},{"schema":{"type":"string","format":"date-time"},"in":"query","name":"beforeDate","required":false},{"schema":{"type":"string","format":"date-time"},"in":"query","name":"afterDate","required":false},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"dateSortOrder","required":false},{"schema":{"type":"string"},"in":"query","name":"pageToken","required":false},{"schema":{"type":"string"},"in":"query","name":"folderId","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["count","links","nextPageToken"],"properties":{"count":{"type":"integer"},"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-03-17T12:57:29.714Z"]},"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-03-17T12:57:29.716Z"]},"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]},"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"}]}}}]}},"nextPageToken":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}}}},"/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}$"},"backgroundColor":{"type":"string","pattern":"^[0-9A-Fa-f]{6,8}$"},"size":{"type":"number","minimum":1,"maximum":99},"type":{"type":"string","enum":["png","svg"],"default":"png"},"useDomainSettings":{"type":"boolean","default":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"},"in":"header","name":"accept","required":false}],"responses":{"200":{"description":"Default Response"}}}},"/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}$"},"backgroundColor":{"type":"string","pattern":"^[0-9A-Fa-f]{6,8}$"},"size":{"type":"number","minimum":1,"maximum":99},"type":{"type":"string","enum":["png","svg"],"default":"png"},"useDomainSettings":{"type":"boolean","default":true},"noExcavate":{"type":"boolean"},"linkIds":{"type":"array","items":{"type":"string","pattern":"^(\\d+|lnk_\\w+)$"},"maxItems":150},"domainId":{"type":"string"}}}}},"required":true},"responses":{"201":{"description":"ZIP file containing QR codes","content":{"application/json":{"schema":{"description":"ZIP file containing QR codes"}}}}}}},"/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"},"idString":{"type":"string","pattern":"lnk_[0-9a-zA-Z]+_[0-9a-zA-Z]+","description":"Link ID","example":"lnk_abc123_abcdef"},"error":{"type":"string"}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean"},"error":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean"},"error":{"type":"string"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean"},"error":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean"},"error":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean"},"error":{"type":"string"}}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean"},"error":{"type":"string"}}}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean"},"error":{"type":"string"}}}}}}}}},"/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}}}}},"required":true},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean"},"error":{"type":"string"}}}}}}}}},"/links/archive":{"post":{"summary":"Archive link","tags":["Link Management"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["link_id"],"properties":{"link_id":{"type":"string"},"domain_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean"},"error":{"type":"string"}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}}}},"/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"},"maxItems":150},"domain_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean"},"error":{"type":"string"}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"},"message":{"type":"string"}}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"},"message":{"type":"string"}}}}}}}}},"/links/unarchive":{"post":{"summary":"Unarchive link","tags":["Link Management"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["link_id"],"properties":{"link_id":{"type":"string"},"domain_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean"},"error":{"type":"string"}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"},"message":{"type":"string"}}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}}}},"/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"},"maxItems":150},"domain_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean"},"error":{"type":"string"}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}}}},"/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-03-17T12:57:29.714Z"},"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-03-17T12:57:29.716Z"},"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":[1773752249716]},{"type":"string","format":"iso-date-time","nullable":true}],"description":"Link creation date in milliseconds","example":"2026-03-17T12:57:29.716Z"},"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},"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"},"in":"query","name":"domain_id","required":false},{"schema":{"type":"string","pattern":"lnk_\\w+|\\d+"},"in":"path","name":"linkId","required":true}],"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-03-17T12:57:29.714Z"]},"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-03-17T12:57:29.716Z"]},"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]},"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"},"field":{"type":"string"},"linkId":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"},"field":{"type":"string"},"linkId":{"type":"string"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"},"field":{"type":"string"},"linkId":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"},"field":{"type":"string"},"linkId":{"type":"string"}}}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}}}},"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+"},"in":"path","name":"linkId","required":true}],"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-03-17T12:57:29.714Z"]},"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-03-17T12:57:29.716Z"]},"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]},"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"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}}}},"/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-03-17T12:57:29.714Z"]},"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-03-17T12:57:29.716Z"]},"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]},"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"},"message":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}}}},"/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"}}}},"/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"}}}},"/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-03-17T12:57:29.714Z"]},"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-03-17T12:57:29.716Z"]},"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":[1773752249716]},{"type":"string","format":"iso-date-time","nullable":true}],"description":"Link creation date in milliseconds","examples":["2026-03-17T12:57:29.716Z"]},"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]},"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-03-17T12:57:29.714Z"]},"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-03-17T12:57:29.716Z"]},"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]},"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"},"message":{"type":"string"},"success":{"type":"boolean","default":false},"statusCode":{"type":"integer","default":400}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message","statusCode"],"properties":{"message":{"type":"string"},"success":{"type":"boolean","default":false},"statusCode":{"type":"integer"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message","statusCode"],"properties":{"message":{"type":"string"},"success":{"type":"boolean","default":false},"statusCode":{"type":"integer"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message","statusCode"],"properties":{"message":{"type":"string"},"success":{"type":"boolean","default":false},"statusCode":{"type":"integer"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message","statusCode"],"properties":{"message":{"type":"string"},"success":{"type":"boolean","default":false},"statusCode":{"type":"integer"}}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message","statusCode"],"properties":{"message":{"type":"string"},"success":{"type":"boolean","default":false},"statusCode":{"type":"integer"}}}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message","statusCode"],"properties":{"message":{"type":"string"},"success":{"type":"boolean","default":false},"statusCode":{"type":"integer"}}}}}}}}},"/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"}}}},"/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-03-17T12:57:29.714Z"},"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-03-17T12:57:29.716Z"},"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":[1773752249716]},{"type":"string","format":"iso-date-time","nullable":true}],"description":"Link creation date in milliseconds","example":"2026-03-17T12:57:29.716Z"},"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},"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"},"folderId":{"type":"string"}}}}},"required":true},"parameters":[{"schema":"object","in":"header","name":"type"},{"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-03-17T12:57:29.714Z"]},"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-03-17T12:57:29.716Z"]},"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]},"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"},"message":{"type":"string"},"success":{"type":"boolean","default":false},"statusCode":{"type":"integer","default":400}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message","success","statusCode"],"properties":{"message":{"type":"string"},"success":{"type":"boolean","default":false},"statusCode":{"type":"integer","default":401}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"},"success":{"type":"boolean","default":false}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"},"success":{"type":"boolean","default":false}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message","success","statusCode"],"properties":{"message":{"type":"string"},"success":{"type":"boolean","default":false},"statusCode":{"type":"integer","default":404}}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"},"success":{"type":"boolean","default":false}}}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message","success"],"properties":{"message":{"type":"string"},"success":{"type":"boolean","default":false}}}}}}}}},"/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"},"allowDuplicates":{"type":"boolean","default":false},"links":{"type":"array","items":{"allOf":[{"type":"object","properties":{"allowDuplicates":{"type":"boolean"}}},{"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-03-17T12:57:29.714Z"]},"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-03-17T12:57:29.716Z"]},"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":[1773752249716]},{"type":"string","format":"iso-date-time","nullable":true}],"description":"Link creation date in milliseconds","examples":["2026-03-17T12:57:29.716Z"]},"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]},"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}}}]}},"folderId":{"type":"string","description":"Folder ID"}}}}},"required":true},"responses":{"200":{"description":"Default Response"}}}},"/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"},"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-03-17T12:57:29.714Z"]},"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-03-17T12:57:29.716Z"]},"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]},"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"],"properties":{"message":{"type":"string"},"success":{"type":"boolean"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"},"success":{"type":"boolean"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"},"success":{"type":"boolean"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"},"success":{"type":"boolean"}}}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"},"success":{"type":"boolean"}}}}}}}}},"/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"}}}}}},"parameters":[{"schema":{"type":"string","pattern":"lnk_\\w+_\\w+"},"in":"path","name":"linkId","required":true}],"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-03-17T12:57:29.714Z"]},"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-03-17T12:57:29.716Z"]},"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]},"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"},"field":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"},"field":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"},"field":{"type":"string"}}}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}}}}},"/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},"in":"query","name":"limit","required":false},{"schema":{"type":"integer","default":0,"minimum":0},"in":"query","name":"offset","required":false},{"schema":{"type":"boolean"},"in":"query","name":"noTeamId","required":false},{"schema":{"type":"string"},"in":"query","name":"pattern","required":false},{"schema":{"type":"number"},"in":"query","name":"teamId","required":false},{"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","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"}]},"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},"isFavorite":{"type":"boolean"}}}}}}}}}},"/domains/{domainId}":{"get":{"summary":"Get domain details by id","tags":["Domains"],"parameters":[{"schema":{"type":"integer","minimum":1},"in":"path","name":"domainId","required":true}],"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"],"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"}]},"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}}},{"type":"object","required":["ipExclusions","userPlan"],"properties":{"ipExclusions":{"type":"array","items":{"type":"string"}},"userPlan":{"enum":["tiny","hobby","small","standard","large"]}}}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"},"type":{"type":"string","enum":["accessDenied"]}}}}}}}}},"/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},"in":"path","name":"domainId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean"}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"},"message":{"type":"string"}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}}}},"/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"},"link_ids":{"type":"array","items":{"type":"string","pattern":"lnk_[0-9a-zA-Z]+_[0-9a-zA-Z]+","description":"Link ID","example":"lnk_abc123_abcdef"}}}}}},"required":true},"responses":{"200":{"description":"Default Response"}}}},"/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"},"linkType":{"enum":["increment","random","secure","four-char","eight-char","ten-char"]}}}}},"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"],"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"}]},"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}}}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}}}},"/links/bundle/templates":{"get":{"summary":"Get bundle templates","tags":["Link Bundles"],"description":"Returns all available bundle templates","responses":{"200":{"description":"Default Response"}}}},"/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"}}},"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"},"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"}}},"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"}}}},"/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":{}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"Bundle ULID id"}],"responses":{"200":{"description":"Default Response"}}}},"/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":{}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"Bundle ULID id"}],"responses":{"200":{"description":"Default Response"}}}},"/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"}}}},"/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"}}},"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"}}},"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"}}}},"/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"}}}},"/links/folders/{domainId}":{"get":{"tags":["Link queries"],"description":"Get links folders for the specified domain id","parameters":[{"schema":{"type":"integer"},"in":"path","name":"domainId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/links/folders/{domainId}/{folderId}":{"get":{"tags":["Link queries"],"description":"Get links folder for the specified domain id and user id","parameters":[{"schema":{"type":"integer"},"in":"path","name":"domainId","required":true},{"schema":{"type":"string"},"in":"path","name":"folderId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/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"},"name":{"type":"string"},"color":{"type":"string"},"backgroundColor":{"type":"string"},"logoUrl":{"type":"string"},"logoHeight":{"type":"integer"},"logoWidth":{"type":"integer"},"ecLevel":{"type":"string"},"integrationFB":{"type":"string"},"integrationTT":{"type":"string"},"integrationGA":{"type":"string"},"integrationGTM":{"type":"string"},"integrationAdroll":{"type":"string"},"utmCampaign":{"type":"string"},"utmMedium":{"type":"string"},"utmSource":{"type":"string"},"utmTerm":{"type":"string"},"utmContent":{"type":"string"},"redirectType":{"type":"integer"},"expiresAtDays":{"type":"integer"},"icon":{"type":"string"},"prefix":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Default Response"}}}}},"servers":[{"url":"https://api.short.io","description":"API server"}],"security":[{"apiKey":[]}]}