{"info":{"_postman_id":"273be2bb-fa3d-4888-a404-5df1db0ba15b","name":"Notes API","description":"

Documentation for the API endpoints

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"37003772","collectionId":"273be2bb-fa3d-4888-a404-5df1db0ba15b","publishedId":"2sA3kRJPJw","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-07-16T20:39:17.000Z"},"item":[{"name":"api","item":[{"name":"auth","item":[{"name":"signup","item":[{"name":"Create a new user","id":"80d83226-3dfa-431d-9e2d-55b88214f993","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"\",\n \"password\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/auth/signup","urlObject":{"path":["api","auth","signup"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"49e32cf9-744f-44d6-9d56-b059effdd5e7","name":"User created successfully","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"\",\n \"password\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/auth/signup"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"c544e0a4-357c-4727-9e53-d748ef477c1c","name":"Validation error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"\",\n \"password\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/auth/signup"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n \"\",\n \"\"\n ]\n}"}],"_postman_id":"80d83226-3dfa-431d-9e2d-55b88214f993"}],"id":"159aea98-eba1-44cb-a443-08d5aeddd954","_postman_id":"159aea98-eba1-44cb-a443-08d5aeddd954","description":""},{"name":"login","item":[{"name":"Login to get JWT token","id":"8bde9934-0c67-4b63-a806-465cbb99dc94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"\",\n \"password\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/auth/login","urlObject":{"path":["api","auth","login"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"4e3418a4-77fa-4db3-8a11-a23dbe34fac5","name":"JWT token generated successfully","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"\",\n \"password\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/auth/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"\"\n}"},{"id":"82ca7fab-5696-4abc-9588-0fca1fa255b6","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"\",\n \"password\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/auth/login"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\"\n}"}],"_postman_id":"8bde9934-0c67-4b63-a806-465cbb99dc94"}],"id":"e7343eac-debb-45f5-a9af-6706944d6344","_postman_id":"e7343eac-debb-45f5-a9af-6706944d6344","description":""}],"id":"3b2eb1de-7efd-4a3f-8468-8733cc787c24","_postman_id":"3b2eb1de-7efd-4a3f-8468-8733cc787c24","description":""},{"name":"notes","item":[{"name":"{id}","item":[{"name":"share","item":[{"name":"Share a note with another user","id":"b6df817e-9dd9-4424-8c62-1a919f0be9e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"receiver_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/notes/:id/share","urlObject":{"path":["api","notes",":id","share"],"host":["/"],"query":[],"variable":[{"id":"ddd5e64a-f213-4dfa-84d6-dd53a0943c75","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"4c35e338-04c3-470f-8abd-481f14c8962d","name":"Note shared successfully","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"receiver_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//api/notes/:id/share","host":["/"],"path":["api","notes",":id","share"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"2b8c73c0-ae4c-44c6-aa33-071417e59e10","name":"Recipient not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"receiver_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//api/notes/:id/share","host":["/"],"path":["api","notes",":id","share"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\"\n}"},{"id":"c9ee225c-654b-435e-8632-89b32a1102dd","name":"Validation error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"receiver_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//api/notes/:id/share","host":["/"],"path":["api","notes",":id","share"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\"\n}"}],"_postman_id":"b6df817e-9dd9-4424-8c62-1a919f0be9e9"}],"id":"dc231d87-a5d8-4abe-a426-c8c9b18135a2","_postman_id":"dc231d87-a5d8-4abe-a426-c8c9b18135a2","description":""},{"name":"Get a specific note by ID","id":"e7e6178f-5a6e-42bf-b7ad-3d7c0521ef19","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/notes/:id","urlObject":{"path":["api","notes",":id"],"host":["/"],"query":[],"variable":[{"id":"e7e87973-ec56-42a0-9f85-0182365308a6","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"de8e5cc2-ea7d-4ec3-837d-8bf4be452297","name":"Note details","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//api/notes/:id","host":["/"],"path":["api","notes",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": \"\",\n \"id\": \"\",\n \"user_id\": \"\"\n}"},{"id":"319701f3-972d-4d7a-ad42-77dbf30f6f63","name":"Note not found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//api/notes/:id","host":["/"],"path":["api","notes",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\"\n}"}],"_postman_id":"e7e6178f-5a6e-42bf-b7ad-3d7c0521ef19"},{"name":"Update a note by ID","id":"d87ff680-a823-4431-8804-312075a3628c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"content\": \"\",\n \"id\": \"\",\n \"user_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/notes/:id","urlObject":{"path":["api","notes",":id"],"host":["/"],"query":[],"variable":[{"id":"ef167b9d-e1fb-4d39-8a32-77d1a7a1a9a4","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"5dc9d0e8-166f-47d2-bd6f-218cbba5610f","name":"Note updated successfully","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"content\": \"\",\n \"id\": \"\",\n \"user_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//api/notes/:id","host":["/"],"path":["api","notes",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": \"\",\n \"id\": \"\",\n \"user_id\": \"\"\n}"},{"id":"4b8c7f9e-5ff7-4c05-a96c-35a0adfca897","name":"Validation error","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"content\": \"\",\n \"id\": \"\",\n \"user_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//api/notes/:id","host":["/"],"path":["api","notes",":id"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n \"\",\n \"\"\n ]\n}"}],"_postman_id":"d87ff680-a823-4431-8804-312075a3628c"},{"name":"Delete a note by ID","id":"d1708d80-9d48-4ff3-b938-8de696eb61b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"//api/notes/:id","urlObject":{"path":["api","notes",":id"],"host":["/"],"query":[],"variable":[{"id":"8873cedd-b867-422f-84f7-ec509cef95aa","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"b99d0697-85f7-4c12-a482-dd6670a52970","name":"Note deleted successfully","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"//api/notes/:id","host":["/"],"path":["api","notes",":id"],"variable":[{"key":"id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d1708d80-9d48-4ff3-b938-8de696eb61b6"}],"id":"3f28825f-2381-49c7-ab2a-695463f36eda","_postman_id":"3f28825f-2381-49c7-ab2a-695463f36eda","description":""},{"name":"Get all notes of the current user","id":"1142f380-2318-47f7-87c2-13b7157ec072","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/notes","urlObject":{"path":["api","notes"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"85d299c6-83cc-416f-b0ce-e13265b93492","name":"List of notes","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/notes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"content\": \"\",\n \"id\": \"\",\n \"user_id\": \"\"\n },\n {\n \"content\": \"\",\n \"id\": \"\",\n \"user_id\": \"\"\n }\n]"}],"_postman_id":"1142f380-2318-47f7-87c2-13b7157ec072"},{"name":"Create a new note","id":"1cce48bc-578f-4094-94ba-c208d58ed5e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"content\": \"\",\n \"id\": \"\",\n \"user_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/notes","urlObject":{"path":["api","notes"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"765e0e7d-3d35-4635-a785-163505188c4f","name":"Note created successfully","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"content\": \"\",\n \"id\": \"\",\n \"user_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/notes"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": \"\",\n \"id\": \"\",\n \"user_id\": \"\"\n}"},{"id":"791befb0-dfe3-4ff3-bfe9-60e88464445b","name":"Validation error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"content\": \"\",\n \"id\": \"\",\n \"user_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/notes"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n \"\",\n \"\"\n ]\n}"}],"_postman_id":"1cce48bc-578f-4094-94ba-c208d58ed5e1"}],"id":"52eb38d4-8391-4585-81d2-bd11371d59d1","_postman_id":"52eb38d4-8391-4585-81d2-bd11371d59d1","description":""},{"name":"search","item":[{"name":"Search notes by content","id":"5814fa7a-1753-49a0-a0f1-017cb183368d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/search?q=","urlObject":{"path":["api","search"],"host":["/"],"query":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"key":"q","value":""}],"variable":[]}},"response":[{"id":"88ac50b9-0a9c-4cec-a872-62a55d8d2539","name":"List of notes matching the search query","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//api/search?q=","host":["/"],"path":["api","search"],"query":[{"description":"(Required) ","key":"q","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"content\": \"\",\n \"id\": \"\",\n \"user_id\": \"\"\n },\n {\n \"content\": \"\",\n \"id\": \"\",\n \"user_id\": \"\"\n }\n]"}],"_postman_id":"5814fa7a-1753-49a0-a0f1-017cb183368d"}],"id":"afc0dddc-9a33-4169-82db-659e8b69ce71","_postman_id":"afc0dddc-9a33-4169-82db-659e8b69ce71","description":""}],"id":"fba8b006-53a4-4638-9b62-14fe84f24e0d","_postman_id":"fba8b006-53a4-4638-9b62-14fe84f24e0d","description":""}],"variable":[{"key":"baseUrl","value":"/"}]}