{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"29e53be8-1e4d-40a6-be06-a6f873910494","name":"LinkTree API Implementation","description":"### What can I do with the API?\n\nThe core features of the API are:\n\t\n* Login/Signup Users.\n* Editing of Users profile.\n* Creating/Editing/Updating/Deleting of Links.\n\nWith the basic features above you can basically build a Linktree clone or at least the base features.\n\n### Rate Limits\nThere are no rate limits set yet.\n\nBased on simple REST principles, this Web API endpoints return JSON metadata about users and links directly from the Database.\n\n### Requests\nThe Web API is based on REST principles. Data resources are accessed via standard HTTPS requests in UTF-8 format to an API endpoint. Where possible, Web API uses appropriate HTTP verbs for each action:\n\nMETHOD |\tACTION\n-------|---------------\nGET    |\tRetrieves resources\nPOST   | Creates resources\nPUT    | Changes and/or replaces resources or collections\nDELETE\t| Deletes resources\n\n### Responses\nWeb API returns all response data as a JSON object. See the Web API Object Model for a description of all the retrievable objects.\n\n\nSTATUS CODE | DESCRIPTION\n------------|------------\n200\tOK | The request has succeeded. The client can read the result of the request in the body and the headers of the response.\n201\tCreated | The request has been fulfilled and resulted in a new resource being created.\n202\tAccepted | The request has been accepted for processing, but the processing has not been completed.\n204\tNo Content | The request has succeeded but returns no message body.\n304\tNot Modified. See Conditional requests.\n400\tBad Request | The request could not be understood by the server due to malformed syntax. The message body will contain more information; see Response Schema.\n401\tUnauthorized | The request requires user authentication or, if the request included authorization credentials, authorization has been refused for those credentials.\n403\tForbidden | The server understood the request, but is refusing to fulfill it.\n404\tNot Found | The requested resource could not be found. This error can be due to a temporary or permanent condition.\n500\tInternal Server Error. You should never receive this error because our clever coders catch them all … but if you are unlucky enough to get one, please report it to us through a comment at the bottom of this page.\n\n### Error Codes\n\nCode | Description | Status\n-----|-------------|--------\nE001 | Insufficient Parameters | 400\nE002 | Invalid Request JSON | 400\nE003 | Username Already Exists | 400\nE004 | Email Already Exists | 400\nE011 | Authentication Error | 401\nE012 | SignUp Error | 401\nE013 | Login Error | 401\nE014 | Error Authenticating User | 400\nE021 | User Does not Exists | 404\nE022 | Cannot Delete this User | 401\nE023 | Cannot Edit this User | 401\nE024 | Error Editing User | 304\nE025 | Error Deleting User | 304\nE031 | Link Does not exists | 404\nE032 | User Cannot Delete this Link | 401\nE033 | User Cannot Edit this Link | 401\nE034 | Error Editing Link | 304\nE035 | Error Deleting Link | 304\nE036 | Error Adding Link | 304\n\n\n### Regular Error Object\nApart from the response code and error codes, unsuccessful responses return a JSON object containing the following information:\n\nKEY\t| VALUE TYPE\t| VALUE DESCRIPTION\n--------|---------------|------------------\nstatus\t| integer\t| The HTTP status code that is also returned in the response header. For further information, see Response Status Codes.\nmessage | string\t| A short description of the cause of the error.\ndata    | Object        |  More info of error\ncode    | string (nullable) | One of the Error codes\n\n### User Object\n\nKEY\t| VALUE TYPE\t\n--------|-----------\npublic_id     | string\nname          | string (nullable)\nusername      | string\nemail         | string (nullable)\ndescription   | string (nullable)\nwebsite       | string (nullable)\nverified      | boolean\nlinks         | List[Link Object]\nsocial_links  | List[Social Link Object]\n\n### Link Object\n\nKEY\t| VALUE TYPE\t\n--------|-----------\ntitle  | string\npublic_id   | string\ndescription | string (nullable)\nurl         | string\n\n### Social Link Object\n\nKEY\t| VALUE TYPE\t\n--------|-----------\nplatform_id | integer\nurl | string\n\n### Auth Object\n\nKEY\t| VALUE TYPE\t\n--------|-----------\ntoken| string\nuser | User Object","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"14039622","collectionId":"29e53be8-1e4d-40a6-be06-a6f873910494","publishedId":"Tzsik4P8","public":true,"publicUrl":"https://documenter-api.postman.tech/view/14039622/Tzsik4P8","privateUrl":"https://go.postman.co/documentation/14039622-29e53be8-1e4d-40a6-be06-a6f873910494","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"1e1f20"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.11.6","publishDate":"2021-08-05T16:12:28.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/Tzsik4P8"}