You need API Key to use the APIs, the API Key can be obtained from Yu3 Dashboard in API Access section.
\nWe use Offset/Limit based pagination and can be controlled using offset and limit parameters for List APIs
To Shorten link, only the target_url parameter is mandatory, utm_tags and name are optional.
Get All links from the account. The results are paginated.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"New URL
\n","type":"text"},{"key":"name","value":"","description":"To Change Name of the Link
\n","type":"text"},{"key":"active","value":"false","description":"true/false, to make link active or inactive
\n","type":"text"}]},"url":"{{host}}/api/v1/link/:id/","description":"The link's target url can only be changed once, once updated, the link cannot be changed again.
\nRest of the paramteres can be updated any number of times. Only the parameters to be updated should be sent
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"ID of the link
\n","type":"text/plain"},"type":"any","value":"6481dfe0-6a96-4c4c-a16a-a1b2f05024c7","key":"id"}]}},"response":[{"id":"2a73d87d-f4cd-4711-ac65-60cd08e5ef61","name":"Example Response","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"formdata","formdata":[{"key":"target_url","value":"https://google.com","description":"New URL","type":"text"},{"key":"name","value":"","description":"To Change Name of the Link","type":"text","disabled":true},{"key":"active","value":"","description":"true/false, to make link active or inactive","type":"text","disabled":true}]},"url":{"raw":"{{host}}/api/v1/link/:id/","host":["{{host}}"],"path":["api","v1","link",":id",""],"variable":[{"key":"id","value":"6481dfe0-6a96-4c4c-a16a-a1b2f05024c7","description":"ID of the link"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 May 2024 15:00:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Cookie"},{"key":"Allow","value":"GET, PUT, PATCH, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=%2BXxcysyoHDl9%2BFhDPc1WC1BM%2B2REBaDGnxYB01YPGgpRNX1gEhsyn%2FrnI81gqOuEFGNTNRQP%2BiDYP0NzsjglQKcBTeksUdaPM8PuTrbHX1zw%2BMD3%2BEZWkAp6%2F0Rz\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"88bf98bf0f6836eb-YYZ"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"data\": {\n \"id\": \"6481dfe0-6a96-4c4c-a16a-a1b2f05024c7\",\n \"short_url\": \"https://yu3.io/ee3inx\",\n \"domain\": null,\n \"created_on\": \"2024-05-26T04:08:18.358757Z\",\n \"modified_on\": \"2024-05-30T15:00:57.042078Z\",\n \"hits\": 1,\n \"name\": null,\n \"active\": true,\n \"utm_tags\": [],\n \"code\": \"ee3inx\",\n \"target_url\": \"https://google.com\",\n \"is_target_url_updated\": true\n },\n \"version\": \"1.0.9\"\n}"},{"id":"e8f2bf31-8e3a-4ba8-8809-80f1c8373c35","name":"Error Response","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"formdata","formdata":[{"key":"target_url","value":"https://theletstream.com","description":"New URL","type":"text"},{"key":"name","value":"","description":"To Change Name of the Link","type":"text","disabled":true},{"key":"active","value":"","description":"true/false, to make link active or inactive","type":"text","disabled":true}]},"url":{"raw":"{{host}}/api/v1/link/:id/","host":["{{host}}"],"path":["api","v1","link",":id",""],"variable":[{"key":"id","value":"6481dfe0-6a96-4c4c-a16a-a1b2f05024c7","description":"ID of the link"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 May 2024 15:01:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"169"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Cookie"},{"key":"Allow","value":"GET, PUT, PATCH, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=o%2B0OOF%2FxcO%2Bfw9LvulacG5P9JgxlikB0zvJH7vjiXyjYNhr69yj8rqXTMDTYaD23EXHhoB7P1CQQggS4xp%2Bx2GqejvYAjO7RvyyESmk3P2uCssDSSPChXuhUwj2D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"88bf995c8e9d36eb-YYZ"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"err_cd\": \"E-C-COR-0004\",\n \"err_msg\": \"Some data is Invalid, please check.\",\n \"error\": {\n \"target_url\": [\n \"Target URL can only be changed once\"\n ]\n },\n \"version\": \"1.0.9\"\n}"},{"id":"865c1ee1-eb55-4968-994b-b86862dc78a6","name":"Deactivate a link","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"formdata","formdata":[{"key":"target_url","value":"https://theletstream.com","description":"New URL","type":"text","disabled":true},{"key":"name","value":"","description":"To Change Name of the Link","type":"text","disabled":true},{"key":"active","value":"false","description":"true/false, to make link active or inactive","type":"text"}]},"url":{"raw":"{{host}}/api/v1/link/:id/","host":["{{host}}"],"path":["api","v1","link",":id",""],"variable":[{"key":"id","value":"6481dfe0-6a96-4c4c-a16a-a1b2f05024c7","description":"ID of the link"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 May 2024 15:01:49 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Cookie"},{"key":"Allow","value":"GET, PUT, PATCH, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=JgqQmlSTx0BTqpgJIznaLpgPM9L%2Bu%2BgkMOhPQzfzloV1tBeySYUpwZ1GPRfhcuOTbIL2ugCfBdXmTgbMDewobcERpGcc63UnEx4y5gTAPwNkUEg2MBtJQlM47VI1\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"88bf9a061b4836eb-YYZ"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"data\": {\n \"id\": \"6481dfe0-6a96-4c4c-a16a-a1b2f05024c7\",\n \"short_url\": \"https://yu3.io/ee3inx\",\n \"domain\": null,\n \"created_on\": \"2024-05-26T04:08:18.358757Z\",\n \"modified_on\": \"2024-05-30T15:01:49.302091Z\",\n \"hits\": 1,\n \"name\": null,\n \"active\": false,\n \"utm_tags\": [],\n \"code\": \"ee3inx\",\n \"target_url\": \"https://google.com\",\n \"is_target_url_updated\": true\n },\n \"version\": \"1.0.9\"\n}"}],"_postman_id":"1aa1a84c-87fd-4e82-bc2a-1f9832394a17"},{"name":"Get Link","id":"92ec05f6-929f-402b-947c-14c5eed52166","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/api/v1/link/:id/","description":"Get Info about a single link
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"ID of the link
\n","type":"text/plain"},"type":"any","value":"6481dfe0-6a96-4c4c-a16a-a1b2f05024c7","key":"id"}]}},"response":[{"id":"22fd908e-1c97-4a46-848e-c1ea9591fb9f","name":"Example Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/api/v1/link/:id/","host":["{{host}}"],"path":["api","v1","link",":id",""],"variable":[{"key":"id","value":"6481dfe0-6a96-4c4c-a16a-a1b2f05024c7","description":"ID of the link"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 May 2024 15:00:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Cookie"},{"key":"Allow","value":"GET, PUT, PATCH, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=Sjzfz68jcLrM7%2FwEByEKtUaa3lgV7Q0wepHA9RLMXpjTdpqgzg7O4CRotjve0FeTbJFGyhGnu2SgzeSYVWFzwOEJZ5JJy7pYWFvf90Z81DgubwnuUZltN%2BQXqR9w\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"88bf97a2783d36eb-YYZ"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"data\": {\n \"id\": \"6481dfe0-6a96-4c4c-a16a-a1b2f05024c7\",\n \"short_url\": \"https://yu3.io/ee3inx\",\n \"domain\": null,\n \"created_on\": \"2024-05-26T04:08:18.358757Z\",\n \"modified_on\": \"2024-05-28T07:34:29.075126Z\",\n \"hits\": 1,\n \"name\": null,\n \"active\": true,\n \"utm_tags\": [],\n \"code\": \"ee3inx\",\n \"target_url\": \"https://linkedin.com/in/thisisayush\",\n \"is_target_url_updated\": false\n },\n \"version\": \"1.0.9\"\n}"}],"_postman_id":"92ec05f6-929f-402b-947c-14c5eed52166"}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"