Caresync API documentation by Adedoyin Emmanuel Adeniyi
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"25154969","collectionId":"453077a9-10b6-4817-b572-df804142c41a","publishedId":"2sA3BrX9mW","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-04-23T23:34:34.000Z"},"item":[{"name":"Users","item":[{"name":"Create User","id":"a5413c8e-48ad-446b-b706-bdde62cbc4da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Adedoyin Emmanuel\",\n \"username\": \"emmysoft\",\n \"email\": \"adedoyine535@gmail.com\",\n \"password\": \"emmanuel123\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2800/api/user","urlObject":{"path":["user"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"a5413c8e-48ad-446b-b706-bdde62cbc4da"},{"name":"Update User","id":"5ddd44e2-4942-4576-ae6e-fd5265b68e29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Adedoyin Emmanuel\",\n \"username\": \"emmysoft\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2800/api/user","urlObject":{"path":["user"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"5ddd44e2-4942-4576-ae6e-fd5265b68e29"},{"name":"Delete User","id":"386fb9e6-ab2e-4f97-9e81-e09d520e23e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"http://localhost:2800/api/user/651e76417ec271829d04e5c9","urlObject":{"path":["user","651e76417ec271829d04e5c9"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"386fb9e6-ab2e-4f97-9e81-e09d520e23e1"},{"name":"Fetch All Users","id":"a7812826-5c18-4e3b-ae82-333e6375a409","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:2800/api/user","urlObject":{"path":["user"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"a7812826-5c18-4e3b-ae82-333e6375a409"},{"name":"Fetch Users By Id","id":"b09240e6-1b50-4d90-a65b-6e38ba1ac3f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:2800/api/user/651e76417ec271829d04e5c9","urlObject":{"path":["user","651e76417ec271829d04e5c9"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"b09240e6-1b50-4d90-a65b-6e38ba1ac3f3"},{"name":"Search User","id":"1b8d1d83-6755-4e67-a9ca-9c6d9e8d2e13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:2800/api/user/search?searchTerm=Emmysfot","urlObject":{"path":["user","search"],"host":["http://localhost:2800/api"],"query":[{"key":"searchTerm","value":"Emmysfot"}],"variable":[]}},"response":[],"_postman_id":"1b8d1d83-6755-4e67-a9ca-9c6d9e8d2e13"},{"name":"Me","id":"7f61ae3d-9e53-4ea3-8052-230ff5d5cfdc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:2800/api/user/me","urlObject":{"path":["user","me"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"7f61ae3d-9e53-4ea3-8052-230ff5d5cfdc"},{"name":"Fetch Online Users","id":"c164b8d4-3289-418e-a2e9-91bb1176309d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:2800/api/user/online","urlObject":{"path":["user","online"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"c164b8d4-3289-418e-a2e9-91bb1176309d"}],"id":"606ea748-4043-4148-a804-4bf57671ed31","description":"User resource endpoint
\n","_postman_id":"606ea748-4043-4148-a804-4bf57671ed31"},{"name":"Hospitals","item":[{"name":"Create Hospital","id":"360cba0b-4380-4960-bc45-b875625fae6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"clinicName\": \"Jefis\",\n \"username\": \"jefis\",\n \"email\": \"jefis@gmail.com\",\n \"password\": \"jefis123\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2800/api/hospital","urlObject":{"path":["hospital"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"360cba0b-4380-4960-bc45-b875625fae6f"},{"name":"Update Hospital","id":"9f38efae-8351-497d-82bc-589ebc836853","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"clinicName\": \"Jefis\",\n \"username\": \"jefis\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2800/api/user","urlObject":{"path":["user"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"9f38efae-8351-497d-82bc-589ebc836853"},{"name":"Delete Hospital","id":"0032a3af-9cf9-4749-a330-be122f11a536","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"http://localhost:2800/api/hospital/6520d7a4656c75587f722d96","urlObject":{"path":["hospital","6520d7a4656c75587f722d96"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"0032a3af-9cf9-4749-a330-be122f11a536"},{"name":"Fetch All Hospitals","id":"1514f02f-8a0e-48b9-b127-36428fb8c4e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:2800/api/hospital","urlObject":{"path":["hospital"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"1514f02f-8a0e-48b9-b127-36428fb8c4e6"},{"name":"Fetch Hospitals By Id","id":"f4f509a0-0714-4641-8f91-fdf66edbdeab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:2800/api/hospital/651e76417ec271829d04e5c9","urlObject":{"path":["hospital","651e76417ec271829d04e5c9"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"f4f509a0-0714-4641-8f91-fdf66edbdeab"},{"name":"Search Hospital","id":"03d010fd-6322-41d5-be03-45cc5621cfab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:2800/api/hospital/search?searchTerm=bl","urlObject":{"path":["hospital","search"],"host":["http://localhost:2800/api"],"query":[{"key":"searchTerm","value":"bl"}],"variable":[]}},"response":[],"_postman_id":"03d010fd-6322-41d5-be03-45cc5621cfab"},{"name":"Fetch Online Hospitals","id":"8449a340-a402-4659-8c03-785c097e4a79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:2800/api/hospital/online","urlObject":{"path":["hospital","online"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"8449a340-a402-4659-8c03-785c097e4a79"}],"id":"5953da0c-4db3-4c2d-a7a0-034fe0db47dd","description":"Hospital resource endpoint
\n","_postman_id":"5953da0c-4db3-4c2d-a7a0-034fe0db47dd"},{"name":"Appointments","item":[{"name":"Create Appointment","id":"904fbf99-9790-42ee-82c1-2f5969348197","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Jefis meeting\",\n \"description\":\"a meeting with caresync hospital to dicuss my eye issue\",\n \"hospitalId\":\"660759204279f13899d73a0b\",\n \"userId\":\"66048ff1524fda326aff00f7\",\n \"startDate\":\"2026-06-07T20:58:51.554Z\",\n \"endDate\":\"2026-06-07T20:58:51.554Z\",\n \"medicalRecordAccess\": false\n \n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2800/api/appointment","urlObject":{"path":["appointment"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"904fbf99-9790-42ee-82c1-2f5969348197"},{"name":"Update Appointment","id":"30ea07d4-6ae6-4186-9fc4-bcd20bec1ee7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"startDate\":\"2026-06-07T20:58:51.554Z\",\n \"endDate\":\"2026-06-07T20:58:51.554Z\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2800/api/appointment/6520ecdc20e094f47dc044e7","urlObject":{"path":["appointment","6520ecdc20e094f47dc044e7"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"30ea07d4-6ae6-4186-9fc4-bcd20bec1ee7"},{"name":"Cancel Appointment","id":"4f981ef2-c270-4ce6-9635-97b430f3a9cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"http://localhost:2800/api/appointment/cancel/651e76417ec271829d04e5c9","urlObject":{"path":["appointment","cancel","651e76417ec271829d04e5c9"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"4f981ef2-c270-4ce6-9635-97b430f3a9cf"},{"name":"Approve Appointment","id":"fae552e9-2dea-48a8-be3a-dc6fce9b6e05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"http://localhost:2800/api/appointment/approve/651e76417ec271829d04e5c9","urlObject":{"path":["appointment","approve","651e76417ec271829d04e5c9"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"fae552e9-2dea-48a8-be3a-dc6fce9b6e05"},{"name":"Delete Appointment","id":"735e9f14-94bb-46c0-98da-3aa334eaedd5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:2800/api/user/651e76417ec271829d04e5c9","urlObject":{"path":["user","651e76417ec271829d04e5c9"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"735e9f14-94bb-46c0-98da-3aa334eaedd5"},{"name":"Fetch All Appointments","id":"f545af37-5d11-4859-9b65-e05f28daa41d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"jwt","jwt":{"basicConfig":[{"key":"secret","value":"Appointment resource endpoint
\n","_postman_id":"e17cfbf0-3e33-4592-873f-27cf7d87484c"},{"name":"Reviews","item":[{"name":"Create Review","id":"b7f01a15-cbb1-4775-a1f8-7f5c87d83546","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"message\": \"I love this hospital\",\n \"rating\": 4,\n \"userId\": \"66048ff1524fda326aff00f7\",\n \"hospitalId\": \"660759204279f13899d73a0b\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2800/api/review","urlObject":{"path":["review"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"b7f01a15-cbb1-4775-a1f8-7f5c87d83546"},{"name":"Update Review","id":"16b55b60-f9a1-471a-9e26-5ae3f9fd8fd0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"message\": \"I don't like how I was attended to, please fix up\",\n \"rating\": 2,\n \"userId\": \"66048ff1524fda326aff00f7\",\n \"hospitalId\": \"660759204279f13899d73a0b\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2800/api/review/660759204279f13899d73a0b","urlObject":{"path":["review","660759204279f13899d73a0b"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"16b55b60-f9a1-471a-9e26-5ae3f9fd8fd0"},{"name":"Delete Review","id":"5afbe4f9-c557-41ac-8bed-dd9dff724902","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:2800/api/review/660759204279f13899d73a0b","urlObject":{"path":["review","660759204279f13899d73a0b"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"5afbe4f9-c557-41ac-8bed-dd9dff724902"},{"name":"Fetch All Reviews","id":"183db621-fd8a-4436-8918-73b0295e2467","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"jwt","jwt":{"basicConfig":[{"key":"secret","value":"Appointment resource endpoint
\n","_postman_id":"3f6c1872-92ad-4c6d-8ce5-aa84289abbfd"},{"name":"Auth","item":[{"name":"Login","id":"beffe139-3361-40c4-a74b-bf8393f656a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\n \"email\": \"adedoyine535@gmail.com\",\n \"password\": \"emmysoft\",\n \"userType\":\"user\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2800/api/auth/login","urlObject":{"path":["auth","login"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"beffe139-3361-40c4-a74b-bf8393f656a8"},{"name":"Logout","id":"be4b3389-73ce-416e-8911-4e80e3df4d95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://localhost:2800/api/auth/logout","urlObject":{"path":["auth","logout"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"be4b3389-73ce-416e-8911-4e80e3df4d95"},{"name":"Refresh Token","id":"c71aa645-9365-470a-8126-71c4a208368b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Authentication and Authorization
\n","_postman_id":"8e256864-14ee-447d-8707-6b9978a28cdb"},{"name":"Room","item":[{"name":"Get Room Token","id":"d594e757-eeb5-4046-8116-88505ac9108c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:2800/api/room/get-token","urlObject":{"path":["room","get-token"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"d594e757-eeb5-4046-8116-88505ac9108c"}],"id":"3d9e1775-a756-44a3-98e1-07c21bd651be","_postman_id":"3d9e1775-a756-44a3-98e1-07c21bd651be","description":""},{"name":"Medical Records","item":[{"name":"Create Medical Record","id":"345df86f-3c15-4f49-b1c9-3ea13a3abac8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"userId\":\"66048ff1524fda326aff00f7\",\n \"symptoms\":\"headache, fever, sorethroat\",\n \"diagnosis\":\"malaria fever\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2800/api/medical-record","urlObject":{"path":["medical-record"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"345df86f-3c15-4f49-b1c9-3ea13a3abac8"},{"name":"Update Medical Record","id":"85adc5d8-7d50-4caf-bf88-5560013fd19b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"userId\":\"66048ff1524fda326aff00f7\",\n \"symptoms\":\"headache, fever, sorethroat\",\n \"diagnosis\":\"malaria fever\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2800/api/medical-record","urlObject":{"path":["medical-record"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"85adc5d8-7d50-4caf-bf88-5560013fd19b"},{"name":"Get My Medical Records","id":"1a86d1eb-5648-413e-914d-175aa167d5dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:2800/api/medical-record/me","urlObject":{"path":["medical-record","me"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"1a86d1eb-5648-413e-914d-175aa167d5dc"},{"name":"Get All Medical Records","id":"fddb6d15-8d37-4fc9-8438-530a1911870e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:2800/api/medical-record/","urlObject":{"path":["medical-record",""],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"fddb6d15-8d37-4fc9-8438-530a1911870e"},{"name":"Get Medical Recoords By Id","id":"aa3c5455-5201-46e5-a79d-4579d79edaee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:2800/api/medical-record/6606a3d8422e447f62802f8a","urlObject":{"path":["medical-record","6606a3d8422e447f62802f8a"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"aa3c5455-5201-46e5-a79d-4579d79edaee"},{"name":"Delete Medical Record","id":"e38a134a-bfc3-410f-917c-264b7d57ea09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:2800/api/medical-record/6606a3d8422e447f62802f8a","urlObject":{"path":["medical-record","6606a3d8422e447f62802f8a"],"host":["http://localhost:2800/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"e38a134a-bfc3-410f-917c-264b7d57ea09"}],"id":"0df3111d-63a6-4f0a-b083-6665f9b057e4","_postman_id":"0df3111d-63a6-4f0a-b083-6665f9b057e4","description":""},{"name":"Symptoms Checker","item":[{"name":"Check Symptoms","id":"1983f809-a014-42b2-8720-08457644a623","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"symptoms\":\"headache, sore throat\",\n \"birthYear\":2005,\n \"gender\":\"male\"\n}","options":{"raw":{"language":"json"}}},"url":"localhost:2800/api/symptoms-checker","urlObject":{"port":"2800","path":["api","symptoms-checker"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"1983f809-a014-42b2-8720-08457644a623"}],"id":"43eeece1-6327-4969-8df5-2541ab1b6fc3","_postman_id":"43eeece1-6327-4969-8df5-2541ab1b6fc3","description":""}],"event":[{"listen":"prerequest","script":{"id":"2133eafc-03b9-4536-81a7-adfcc7f5918e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ea232a0e-81b6-4d23-a4ac-f7cd2c17993e","type":"text/javascript","exec":[""]}}],"variable":[{"key":"BASE_URL","value":"http://localhost:2800/api","type":"string"},{"key":"ACCESS_TOKEN","value":"","type":"string"}]}