This a collection of all the endpoints in the meet-API and a walkthrough of how to make requests to each endpoint.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"33652201","collectionId":"6ad97505-fdea-4f5f-a08b-9ba1d209c055","publishedId":"2sB2xFgTgT","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-06-29T16:14:10.000Z"},"item":[{"name":"Setup","item":[{"name":"register","event":[{"listen":"test","script":{"id":"10daded8-257f-43c0-9486-b54a7534027a","exec":["var template = `\r","\r","\r","| Response | \r","Username | \r","Category | \r","First Name | \r","Last Name | \r","Phone Number | \r","Token | \r","|
|---|---|---|---|---|---|---|---|
| {{response}} | \r","{{email}} | \r","{{username}} | \r","{{category}} | \r","{{first_name}} | \r","{{last_name}} | \r","{{phone_number}} | \r","{{token}} | \r","
to specify the type of the data being sent(it can also be set to 'multipart/form-data' if a form data is being sent)
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"email\": \"{email}\",\r\n \"first_name\": \"{first name}\",\r\n \"last_name\": \"{last name}\",\r\n \"username\": \"{username}\",\r\n \"password\": \"{password}\",\r\n \"password2\": \"{password}\",\r\n \"category\": \"{category}\",\r\n \"phone_number\": \"{phone number}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://meet-api-3uf7.onrender.com/api/users/register/","description":"This is the endpoint that users send requests to to register as a user.
\nTo create an account, add the following to the request's body
\nfirst name
\nlast name
\nusername
\npassword
\npassword2 - A string that needs to match the password entered above
\ncategory - A string that specifies what type of account a user is trying to create.
\n\n\n'PT' (for users signing up as a patient)
\n
'DR' (for users signing up as a doctor)
Note: phone numbers should not be written with country code(e.g +234)
The phone number field is also the only field not required from the list of fields above
To obtain the auth token of the user, make a request to this endpoint with the user's email and password as request data.
\nemail - the email of the user
\npassword - the password of the user
\nThis folder contains instructions on what users need to do to setup their Meet-API account
\n","_postman_id":"33d39e6c-00e3-447d-86c5-7a58f330b88b"},{"name":"endpoints","item":[{"name":"Complaint endpoints","item":[{"name":"Get symptoms","id":"997874fd-2060-49c4-9783-66ade85b1ece","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"TokenThis is the endpoint that a request should be sent to to get the list of available symptoms.
\nNote: The response in this endpoint is paginated. It has 5 objects per page. All other list endpoints in the API is paginated the same way
\n","urlObject":{"protocol":"https","path":["api","booking","symptoms","list",""],"host":["meet-api-3uf7","onrender","com"],"query":[],"variable":[]}},"response":[{"id":"bf3f63d5-e774-40dd-ad33-fcabff8efc81","name":"Get symptoms","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"TokenThis is the endpoint to call when a patient wants to logde a complaint. The enpoint returns an illness suggestion together with related doctor suggestions.
\nThe endpoint requires the following fields
\nsymptom - The id of a previously chosen symptom(String)
\nsex - The sex of the patient
\nyear_of_birth - The year of birth of the patient(Integer)
\nage_group - This is a choice field that specifies the age group that the patient falls under. It has the following choices
\n\n\nPT - Pre-teen
\n
TN - Teenager
AD - Adult
OAD - Old Adult
Note : The list of symtomps containing their names and id can be gotten from the symptoms list endpoint.
\n","urlObject":{"protocol":"https","path":["api","booking","complaint","match",""],"host":["meet-api-3uf7","onrender","com"],"query":[],"variable":[]}},"response":[{"id":"b57dc6c6-d892-42fe-9408-33eaf9b5c8d8","name":"No doctor match","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"TokenThis is the endpoint to make request to when a user wants to update their lodged complaint.
\nNote: A complaint that already has a meet booked for it cannot be updated
\n","urlObject":{"protocol":"https","path":["api","booking","complaint","{complaint_id}","update",""],"host":["meet-api-3uf7","onrender","com"],"query":[],"variable":[]}},"response":[{"id":"0f3a2d4e-baa6-424e-b289-649a798ccfe7","name":"no doctor match","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"TokenAfter details about a complaint have been lodged and suggestions have been generated for it, the complaint is saved to the database. This enables a patient to be able to access their medical history and doctors are able to access medical history of their patients.
\nNote: A complaint's details can only be accessed by the patient who lodged the complaint and doctors who that patient is currently in a meet with.
\n","urlObject":{"protocol":"https","path":["api","booking","complaint","{complaint_id}",""],"host":["meet-api-3uf7","onrender","com"],"query":[],"variable":[]}},"response":[{"id":"5d611317-5782-4a08-9cab-f79f9c8ea029","name":"Get complaint unauthorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"TokenThis is the endpoint that would be called if a user signed up as a doctor wants to see the complaint history of a patient that has booked them for a meet. Patients are not allowed to access the endpoint as the list of their lodged complaints can already be found in their user details.
\nThis list can be filtered by symptoms, age_group, patient’s first and last name
\n","urlObject":{"protocol":"https","path":["api","booking","complaint","list",""],"host":["meet-api-3uf7","onrender","com"],"query":[{"disabled":true,"description":{"content":"symptom, age group or patient name to filter by.(optional)
\n","type":"text/plain"},"key":"search","value":"{search option}"},{"key":"username","value":"{patient's username}"}],"variable":[]}},"response":[{"id":"d1bd05f2-0d86-4141-892a-98dd8a2d0f23","name":"Forbidden request","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"TokenThis is folder contains all the endpoints for everything that has to do with complaints
\n","_postman_id":"e8a829e1-938f-4d23-9a7f-87950dff0cc6"},{"name":"Meet endpoints","item":[{"name":"Book a meet","id":"3a59e0f5-2a79-4f8c-9591-08cedccc52e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"TokenAuthentication token of patient trying to book a doctor for a meet
\n","type":"text"}],"url":"https://meet-api-3uf7.onrender.com/api/booking/meet/{doctor username}/book/?complaint={complaint_id}","description":"After lodging a complaint and getting suggestions, the next step for a patient is to book a meet with one of the suggested medical practitioners.
\n\n\nA meet can be interpreted as booking a doctor for consultation.
\n
Note: A doctor can only be booked for three meets at a time. This is to ensure that a doctor is not overbooked and that they have enough time to finish their consultation period with a patient. A doctor is not allowed to access this endpoint.
\nThe \"doctor username\" and \"complaint id\" in this url refers to the username of the doctor that the patient wants to book and the id of the complaint that the patient is booking for.
\nThis endpoint should also be called if a user wants to cancel/delete a meet that they have booked. A meet cannot be canceled after it has been confirmed by the doctor, it can only be ended.
\n","urlObject":{"protocol":"https","path":["api","booking","meet","{doctor username}","book",""],"host":["meet-api-3uf7","onrender","com"],"query":[{"description":{"content":"The id of the complaint that the meet is being booked for
\n","type":"text/plain"},"key":"complaint","value":"{complaint_id}"}],"variable":[]}},"response":[{"id":"2de142ec-e12a-47a6-b6e6-c14516908399","name":"book meet","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"TokenThis endpoint is called to get the details of a meet. The ID is a unique string attached to each meet when they are booked.
\nBoth Doctors and Patients are allowed to access this endpoint as long as they are the doctor and patient that the meet was booked for initially.
\n","urlObject":{"protocol":"https","path":["api","booking","meet","{meet_ID}",""],"host":["meet-api-3uf7","onrender","com"],"query":[],"variable":[]}},"response":[{"id":"a7c6478c-99bb-4344-964e-5be92f87c6cc","name":"get meet successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"TokenAfter a meet has been booked by a patient, the booked doctor is notified and prompted to confirm the meet. This is to acknowledge the meet and confirm that they are ready for consultation.
\nNote: Only doctors can access this endpoint.
\n","urlObject":{"protocol":"https","path":["api","booking","meet","{meet_ID}","confirm",""],"host":["meet-api-3uf7","onrender","com"],"query":[],"variable":[]}},"response":[{"id":"3faede07-68f4-418c-9413-5e2ad0e57d0c","name":"confirm meet","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"TokenAfter a patient has completed their consultation with a doctor, they can access this endpoint in order to end the meet. The meets that have been ended have a has_ended attribute set to True. Patients can also call this endpoint if they want to cancel their meet with a doctor that they feel is not qualified enough or not of any help to them.
\nOnly patients can access this endpoint.
\n","urlObject":{"protocol":"https","path":["api","booking","meet","{meet_ID}","end",""],"host":["meet-api-3uf7","onrender","com"],"query":[],"variable":[]}},"response":[{"id":"24c6e8d3-4551-4487-af68-bfb225b0c2e3","name":"end meet successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"TokenThis is the endpoint that users make requests to if they want to get a list of meets. Doctors can get a list of meets that have been booked for, while patients can get a list of meets they have booked. The list can be filterd by the name of a doctor/patient and the id of the symptom that was in the complaint that the meet was booked for.
\n","urlObject":{"protocol":"https","path":["api","booking","meet","list",""],"host":["meet-api-3uf7","onrender","com"],"query":[{"disabled":true,"description":{"content":"this is an object field that is used to search/filter the list of meets. Could be the complaint symptom ID, doctor and patient's first or last names
\n","type":"text/plain"},"key":"search","value":"{search option}"},{"key":"active","value":"{true/false}"}],"variable":[]}},"response":[{"id":"c1c66e39-42cc-48a3-a127-162c553bb074","name":"doctor's active meets list","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"TokenThis folder contains instructions on how to make requests to all endpoints pertaining to booking a meet, viewing a meet, confirming a meet and more
\n","_postman_id":"5fb7a3c4-437f-43f0-9bce-c0a90637fb66"},{"name":"Appointment endpoints","item":[{"name":"Create appointment","id":"58a881b1-796b-4eb0-965d-ecd3b156cae4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"TokenThis is the endpoint that a request is sent to when the doctor wants to schedule appointments with the patients they have meets with. Only a doctor is allowed to schedule an appointment.
\nThe fields required are:
\nDate of appointment(required)
\nTime of appointment(required)
\nTo get details about a specific appointment make a get request to this endpoint. Both doctors and patients are allowed to access this endpoint.
\n","urlObject":{"protocol":"https","path":["api","booking","appointment","{appointment id}",""],"host":["meet-api-3uf7","onrender","com"],"query":[],"variable":[]}},"response":[{"id":"9c6bb243-6f6e-4780-9b21-5c5ac1f74b1f","name":"get appointment","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Tokenhas to be the authentication token of the doctor that scheduled the appointment.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"time_of_appointment\": \"HH:MM:SS\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://meet-api-3uf7.onrender.com/api/booking/appointment/{appointment id}/update/","description":"After an appointment has been scheduled, a doctor is allowed to update the date and time of the appointment.
\nNote: Appointments cannot be deleted. This enables the doctor and patient to see the history of all the appointments they had throughout the consultation.
\n","urlObject":{"protocol":"https","path":["api","booking","appointment","{appointment id}","update",""],"host":["meet-api-3uf7","onrender","com"],"query":[],"variable":[]}},"response":[{"id":"c2bcb18e-cb0a-4a4f-8872-6dd05cfaefc5","name":"update appointment","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"TokenThis is the folder that gives instructions on how to create, update and get appointments
\n","_postman_id":"afc0fdca-dfa4-478b-8f6c-34e171d75832"},{"name":"User Management endpoints","item":[{"name":"Profile","item":[{"name":"Update profile","id":"2aa7d0ae-6bbe-4bc0-a936-0f23cb503808","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"TokenAfter a doctor creates an account, they get a profile that contains details about thier specialization, meets, appointments, reviews and rating. To update the profile, send a request to this endpoint with the following fields.
\nspecialization - The field that the doctor specializes in(e.g Otolarynology, Gynaecology)
\npatient type - This is the field that groups the ages of patients that the doctor prefers to treat. Can be one of Preteen, Teenager, Adult, Old Adult.
\n\n\nThe patient type field is a choice field and it is represented by abbreviations.
\n
- 'PT' for Preteen
- 'TN' for Teenager
- 'AD' for Adult
- 'OAD' for Old Adult
*pro tip: Use a dropdown containing the various types and pass the abbreviations to the body of the request.
\nNote: The profile slug is the patient's username.
\n","urlObject":{"protocol":"https","path":["api","users","profile","{profile slug}","update",""],"host":["meet-api-3uf7","onrender","com"],"query":[],"variable":[]}},"response":[{"id":"de5b09a7-74b6-4ce4-83fb-018da59a1131","name":"update profile","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"TokenA doctor can access the details in their profile by making a request to this endpoint. A patient can also access a doctor's profile, but are restricted from getting certain data in the request response.
\nNOTE: The profile slug in the urls above refers to the username of the profile owner.
\n","urlObject":{"protocol":"https","path":["api","users","profile","{profile slug}",""],"host":["meet-api-3uf7","onrender","com"],"query":[],"variable":[]}},"response":[{"id":"844a368f-04c8-44a4-a2d3-44c2568063b3","name":"get profile by doctor","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"TokenThis folder is where details about how doctors can update their specializations and age group categories can be found.
\n","_postman_id":"a146a20e-b9dc-44c8-b67c-475934f9b4f4"},{"name":"User details","item":[{"name":"Get user","id":"ceed6361-684a-46ba-9d5f-b4ec11171683","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"TokenAll users are allowed to make requests to get their details(name, username, complaints list, meets, appointments e.t.c). Note that the complaints list is always empty for doctors. The meets and appointments lists are also empty since they can be found in doctor profiles.
\n","urlObject":{"protocol":"https","path":["api","users","details","{username}",""],"host":["meet-api-3uf7","onrender","com"],"query":[],"variable":[]}},"response":[{"id":"ff22f224-7c56-4dd4-8c89-0308a7cd7f6f","name":"get patient details","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"TokenIf a user wants to update their details, they can make a request to this endpoint.
Below is the list of fields that can be update
username
\nfirst_name
\nlast_name
\nphone_number
\nThe auth token of the user that want's to delete their account
\n","type":"text"}],"url":"https://meet-api-3uf7.onrender.com/api/users/{user's username}/delete","description":"This is the endpoint to make a request to if a user wants to delete their account.
\n","urlObject":{"protocol":"https","path":["api","users","{user's username}","delete"],"host":["meet-api-3uf7","onrender","com"],"query":[],"variable":[]}},"response":[{"id":"23d87065-71df-458f-a161-5b5a7c424cf8","name":"delete successful","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"TokenThis folder contains endpoints on how to get users, update users and delete users
\n","_postman_id":"36977b04-bac7-4f8c-9402-425d7dd8e561"},{"name":"Password endpoints","item":[{"name":"Request OTP","id":"687b739b-9f13-4d72-91fe-160f50831965","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://meet-api-3uf7.onrender.com/api/users/request-otp/","description":"To be able to reset a password, a user needs to request for an OTP. Add the user's email to the request query parameter and make a get request to the endpoint.
\n","urlObject":{"protocol":"https","path":["api","users","request-otp",""],"host":["meet-api-3uf7","onrender","com"],"query":[{"disabled":true,"description":{"content":"email of the user requesting the otp
\n","type":"text/plain"},"key":"email","value":"After the OTP has been requested and sent, the user needs to verify the otp sent to them before they can proceed with their action. To achieve this, add the user's email and the otp inputed by them to the request's query parameter.
\n","urlObject":{"protocol":"https","path":["api","users","verify-otp",""],"host":["meet-api-3uf7","onrender","com"],"query":[{"disabled":true,"description":{"content":"The email of the user trying to verify their otp
\n","type":"text/plain"},"key":"email","value":"The One-time password sent to the user's email
\n","type":"text/plain"},"key":"otp","value":"After the otp has been verified, the user can then go ahead and access the reset password endpoint. The field required are:
\nnew_password - The new password of the user
\nconfirm_password - The new password of the user entered again for confirmation.
\nNote: The user's email should also be added to the query parameter of the request
\n","urlObject":{"protocol":"https","path":["api","users","change-password",""],"host":["meet-api-3uf7","onrender","com"],"query":[{"disabled":true,"description":{"content":"The email of the user that wants to reset their password
\n","type":"text/plain"},"key":"email","value":"This folder that contains all information about user management. Everything from profile updates to password reset is explained here.
\n","_postman_id":"0237bb63-eaf7-4119-a158-6558fb95d381"},{"name":"Review endpoints","item":[{"name":"Create Review","id":"74f84b8c-6b42-47c8-b59d-11285425242e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"TokenAfter a patient has completed their consultation with a doctor, they are allowed to drop a review about their experience with the doctor. This is the endpoint they make a request to achieve this.
\nTo create a review, the following fields are required
\nbody - This is the body of the review that the patient is creating
\nstars - This is the rating that user wants to give the doctor. It is an integer field.
\nMake a request to this endpoint to view the details of a particular review.
\nNote: Only patients and the doctor that the review was written about have access to this endpoint.
\n","urlObject":{"protocol":"https","path":["api","users","review","{review_id}",""],"host":["meet-api-3uf7","onrender","com"],"query":[],"variable":[]}},"response":[{"id":"425d0bf3-f66c-4f08-8c37-f53669860034","name":"get review","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"TokenFor patients to get a list of reviews written about a particular doctor in order to inform their doctor consultation choice, a request needs to be made to this endpoint.
\nThis endpoint is restricted to patients only. They can get the list of reviews written about them from their profile detail.
\n","urlObject":{"protocol":"https","path":["api","users","reviews","{doctor_username}","list",""],"host":["meet-api-3uf7","onrender","com"],"query":[],"variable":[]}},"response":[{"id":"ffddbdfa-8879-495b-8b90-391f5f264be8","name":"List reviews","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"TokenThis is the endpoint to make a request to to delete a review. Only patients can access this endpoint.
\n","urlObject":{"protocol":"https","path":["api","users","review","{review_id}","delete"],"host":["meet-api-3uf7","onrender","com"],"query":[],"variable":[]}},"response":[{"id":"d05758d5-5424-4949-bc07-0379e738ba2a","name":"Delete review","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"TokenThis is a folder on how to create, delete, get and list reviews
\n","_postman_id":"86014312-36ba-438d-9050-100557b16772"}],"id":"304dfca5-99e7-46cc-b905-47eeb42bf7d9","description":"This folder contains the documentation of all the endpoints that the API has
\n","_postman_id":"304dfca5-99e7-46cc-b905-47eeb42bf7d9"}],"event":[{"listen":"prerequest","script":{"id":"d5b5798f-9dee-4433-aad6-51d7613a0cc0","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"96ee7dd2-b6a0-4ae4-b4a4-0dcc273c79d6","type":"text/javascript","packages":{},"exec":[""]}}]}