The endpoint retrieves the waiting list count and user details.
\nWaitingListCount (number, required): The count of users in the waiting list.
\nusers (array, required): An array of user objects.
\n_id (string, required): The unique identifier for the user.
\nemail (string, required): The email address of the user.
\n__v (number, required): Version key for the user object.
\nExample:
\n{\n \"WaitingListCount\": 0,\n \"users\": [\n {\n \"_id\": \"\",\n \"email\": \"\",\n \"__v\": 0\n }\n ]\n}\n\nThis POST request is used to add an email to the waiting list.
\nThe response for this request is a JSON object with the following schema:
\n{\n \"message\": \"string\",\n \"data\": {\n \"message\": \"string\",\n \"user\": {\n \"email\": \"string\",\n \"_id\": \"string\",\n \"__v\": 0\n }\n }\n}\n\nmessage (string): A message related to the response.
\ndata (object): The main data object containing additional information.
\nmessage (string): A message related to the data.
\nuser (object): An object containing user information.
\nemail (string): The user's email address.
\n_id (string): The unique identifier for the user.
\n__v (number): Version number.
\nThis endpoint allows users to sign up by providing their first name, last name, email, and password.
\nfirstName (string, required): The first name of the user.
lastName (string, required): The last name of the user.
email (string, required): The email address of the user.
password (string, required): The password for the user account.
isGoogleSigned (boolean, required): Indicates whether the user signed up using a Google account.
Example:
\n{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"johndoe@example.com\",\n \"password\": \"qwerty\",\n \"isGoogleSigned\": false\n}\n\nnewUser (object): Details of the newly created user.
firstName (string): First name of the user.
lastName (string): Last name of the user.
email (string): Email address of the user.
role (string): Role of the user.
isGoogleSigned (boolean): Indicates whether the user signed up using a Google account.
bio (string): User's bio information.
avatar (string): URL of the user's avatar.
status (string): Status of the user account.
isEmailVerified (boolean): Indicates whether the user's email is verified.
otpExpiry (string): Expiry date of the OTP (One-Time Password).
subscriptionStatus (string): Subscription status of the user.
retryCount (number): Count of retry attempts.
nextBillingDate (string): Date of the next billing cycle.
_id (string): Unique identifier of the user.
createdAt (string): Date and time of user creation.
updatedAt (string): Date and time of last update.
__v (number): Version of the user data.
token (string): Authentication token for the newly created user.
Example:
\n{\n \"message\": \"\",\n \"data\": {\n \"newUser\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"johndoe@example.com\",\n \"role\": \"\",\n \"isGoogleSigned\": true,\n \"bio\": null,\n \"avatar\": null,\n \"status\": \"\",\n \"isEmailVerified\": true,\n \"otpExpiry\": \"\",\n \"subscriptionStatus\": \"\",\n \"retryCount\": 0,\n \"nextBillingDate\": null,\n \"_id\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"__v\": 0\n },\n \"token\": \"\"\n }\n}\n\nThis endpoint allows the user to log in by providing the login ID, password, and an indication of whether the user is signing in using a Google account.
\nRequest Body
\nloginId (string): The user's login ID or email.
password (string): The user's password.
isGoogleSigned (boolean): Indicates whether the user is signing in using a Google account.
Response
\nmessage (string): A message indicating the outcome of the login attempt.
data (object): An object containing user information and authentication token.
user (object): User details including ID, email, role, Google sign-in status, and other profile information.
_id (string): User ID.
firstName (string): User's first name.
lastName (string): User's last name.
email (string): User's email.
role (string): User's role or access level.
isGoogleSigned (boolean): Indicates if the user is signed in using a Google account.
bio (string): User's biography or profile description.
avatar (string): URL of the user's avatar or profile picture.
status (string): User's account status.
isEmailVerified (boolean): Indicates if the user's email is verified.
otpExpiry (string): Expiry date for one-time password verification.
subscriptionStatus (string): User's subscription status.
retryCount (number): Number of login retry attempts.
nextBillingDate (string): Date of the next billing cycle for subscription.
createdAt (string): Timestamp of user account creation.
updatedAt (string): Timestamp of user account update.
__v (number): Version number of the user record.
token (string): Authentication token for the logged-in user.
This endpoint allows the user to reset their password by providing the OTP (One Time Password) and the new password.
\notp (number) - The OTP received by the user.
newPassword (string) - The new password to be set.
The response will be in JSON format with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n },\n \"data\": {\n \"type\": [\"object\", \"null\"]\n }\n }\n}\n\nThe response will contain:
\nmessage (string) - A message indicating the result of the password reset request.
data (object or null) - Additional data related to the password reset, or null if there is no additional data.
This endpoint retrieves user information based on the provided user ID.
\nNo request body is required for this endpoint.
\nThe response will be in JSON format with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"message\": { \"type\": \"string\" },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"user\": {\n \"type\": \"object\",\n \"properties\": {\n \"_id\": { \"type\": \"string\" },\n \"firstName\": { \"type\": \"string\" },\n \"lastName\": { \"type\": \"string\" },\n \"email\": { \"type\": \"string\" },\n \"role\": { \"type\": \"string\" },\n \"isGoogleSigned\": { \"type\": \"boolean\" },\n \"bio\": { \"type\": \"string\" },\n \"avatar\": { \"type\": \"string\" },\n \"status\": { \"type\": \"string\" },\n \"isEmailVerified\": { \"type\": \"boolean\" },\n \"subscriptionStatus\": { \"type\": \"string\" },\n \"retryCount\": { \"type\": \"integer\" },\n \"nextBillingDate\": { \"type\": \"string\" },\n \"createdAt\": { \"type\": \"string\" },\n \"updatedAt\": { \"type\": \"string\" },\n \"__v\": { \"type\": \"integer\" }\n }\n }\n }\n }\n }\n}\n\nThis endpoint is used to resend the verification email to the user.
\nThe response for this request is in JSON format with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n },\n \"data\": {\n \"type\": \"null\"\n }\n }\n}\n\nThis endpoint is used to create a new pod.
\nname (string, required): The name of the pod.
\nservice (string, required): The service ID associated with the pod.
\nquotaPerUser (number, required): The quota per user for the pod.
\nmaxMembers (number, required): The maximum number of members allowed in the pod.
\nThe response will contain the details of the newly created pod.
\n","urlObject":{"path":["api","pods"],"host":["http://localhost:3001"],"query":[],"variable":[]}},"response":[{"id":"00a1f2f5-b55e-4f0d-ac64-598e96456625","name":"Success Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Netflix Family Pod\",\n \"service\": \"service_id_1\",\n \"quotaPerUser\": 100\n}"},"url":""},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d894f1c8-2a5e-4116-aad1-dd23912a165c"},{"name":"Get Pods by Service","id":"4cfa9aeb-8da8-4205-9264-6a159beea680","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth_token}}","type":"text"}],"url":"http://localhost:3001/api/pods/service/service_id_1","description":"Get all pods for a specific service
\n","urlObject":{"path":["api","pods","service","service_id_1"],"host":["http://localhost:3001"],"query":[],"variable":[]}},"response":[{"id":"87662b77-4a45-4291-ae09-3164f150a12f","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4cfa9aeb-8da8-4205-9264-6a159beea680"},{"name":"Request to Join Pod","id":"52509e48-5530-4cbd-80da-2608f49171b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{auth_token}}","type":"text"}],"url":"http://localhost:3001/api/pods/pod_id_1/join","description":"This endpoint is used to send a POST request to join a specific pod with the provided pod ID.
\nThe response will include the details of the pod that the user has joined, along with a success message.
\n","urlObject":{"path":["api","pods","pod_id_1","join"],"host":["http://localhost:3001"],"query":[],"variable":[]}},"response":[{"id":"4c3c0139-0cb6-4ddd-8a6e-b7b19758bc84","name":"Success Response","originalRequest":{"method":"POST","header":[],"url":""},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"52509e48-5530-4cbd-80da-2608f49171b6"},{"name":"Approve Join Request","id":"6c85f38a-3b91-4aed-9b49-a05f6726a6ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{auth_token}}","type":"text"}],"url":"http://localhost:3001/api/pods/pod_id_1/members/member_id_1/approve","urlObject":{"path":["api","pods","pod_id_1","members","member_id_1","approve"],"host":["http://localhost:3001"],"query":[],"variable":[]}},"response":[{"id":"03ead9cb-5df4-4dc6-bd87-79f48c880d60","name":"Success Response","originalRequest":{"method":"PUT","header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"6c85f38a-3b91-4aed-9b49-a05f6726a6ef"},{"name":"Remove Member","id":"884213d9-a2af-4f68-852f-0d83edc69b3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{auth_token}}","type":"text"}],"url":"http://localhost:3001/api/pods/pod_id_1/members/member_id_1","description":"Remove a member from the pod (pod owner only)
\n","urlObject":{"path":["api","pods","pod_id_1","members","member_id_1"],"host":["http://localhost:3001"],"query":[],"variable":[]}},"response":[{"id":"a5c569cd-60ef-4171-b629-458dc51abe14","name":"Success Response","originalRequest":{"method":"DELETE","header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"884213d9-a2af-4f68-852f-0d83edc69b3e"},{"name":"Leave Pod","id":"8b1b47be-b2be-4eb9-81a2-7a233b1af9ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{auth_token}}","type":"text"}],"url":"http://localhost:3001/api/pods/pod_id_1/leave","description":"Leave a pod (members only, not owner)
\n","urlObject":{"path":["api","pods","pod_id_1","leave"],"host":["http://localhost:3001"],"query":[],"variable":[]}},"response":[{"id":"dc1f1c23-09d7-453d-9fa5-e6c258c62c7c","name":"Success Response","originalRequest":{"method":"POST","header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8b1b47be-b2be-4eb9-81a2-7a233b1af9ee"},{"name":"Get Pod Members","id":"fd4850ae-dfd6-49c2-b934-4e4e7fa2ad12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth_token}}","type":"text"}],"url":"http://localhost:3001/api/pods/pod_id_1/members","description":"Get all members of a pod
\n","urlObject":{"path":["api","pods","pod_id_1","members"],"host":["http://localhost:3001"],"query":[],"variable":[]}},"response":[{"id":"0fb11c80-1b58-41b4-adf9-8241b226a502","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"fd4850ae-dfd6-49c2-b934-4e4e7fa2ad12"}],"id":"fbc3d6e1-f7b7-41d6-bf62-a1c2c01aa39f","description":"Endpoints for managing pods
\n","_postman_id":"fbc3d6e1-f7b7-41d6-bf62-a1c2c01aa39f"},{"name":"Services","item":[{"name":"Get All Services","id":"f030c8a1-48e8-40a0-a971-6b98bdd6d741","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"http://localhost:3001/api/services?type=entertainment&status=active&search=netflix","description":"Get all services with optional filters
\n","urlObject":{"path":["api","services"],"host":["http://localhost:3001"],"query":[{"key":"type","value":"entertainment"},{"key":"status","value":"active"},{"key":"search","value":"netflix"}],"variable":[]}},"response":[{"id":"f3a71118-dff4-4a56-824d-30eaa485d6af","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f030c8a1-48e8-40a0-a971-6b98bdd6d741"},{"name":"Get Services by Type","id":"c395d68e-613c-47d1-8413-9af636628767","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth_token}}","type":"text"}],"url":"http://localhost:3001/api/services/type/ENTERTAINMENT","description":"Get all services of a specific type
\n","urlObject":{"path":["api","services","type","ENTERTAINMENT"],"host":["http://localhost:3001"],"query":[],"variable":[]}},"response":[{"id":"30e85907-1277-4658-b066-a775db0dbe63","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c395d68e-613c-47d1-8413-9af636628767"},{"name":"Create Service (Admin Only)","id":"09461a09-ff39-4fff-a973-9ad5957111cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{admin_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Apple TV+\",\n \"description\": \"Apple's streaming service\",\n \"type\": \"entertainment\",\n \"maxMembers\": 6,\n \"icon\": \"apple-tv-icon.png\",\n \"metadata\": {\n \"subscriptionTiers\": [\"Individual\", \"Family\"]\n }\n}"},"url":"http://localhost:3001/api/services","description":"Create a new streaming service (requires admin privileges)
\n","urlObject":{"path":["api","services"],"host":["http://localhost:3001"],"query":[],"variable":[]}},"response":[{"id":"51ee994e-3303-49f8-9afd-6296f34d8f25","name":"Success Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Apple TV+\",\n \"description\": \"Apple's streaming service\",\n \"type\": \"ENTERTAINMENT\",\n \"maxMembers\": 6\n}"},"url":""},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"09461a09-ff39-4fff-a973-9ad5957111cf"},{"name":"Update Service (Admin Only)","id":"4a134c8a-a8bd-4311-8da0-8621edd64d82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{admin_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Netflix Premium\",\n \"maxMembers\": 5,\n \"metadata\": {\n \"subscriptionTiers\": [\"Basic\", \"Standard\", \"Premium\", \"Ultra\"]\n }\n}"},"url":"http://localhost:3001/api/services/service_id_1","description":"Update an existing service (requires admin privileges)
\n","urlObject":{"path":["api","services","service_id_1"],"host":["http://localhost:3001"],"query":[],"variable":[]}},"response":[{"id":"1f46a539-1c3b-448a-abaa-6cff32cb50d0","name":"Success Response","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Netflix Premium\",\n \"maxMembers\": 5\n}"},"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4a134c8a-a8bd-4311-8da0-8621edd64d82"},{"name":"Delete Service (Admin Only)","id":"4e5d959b-e104-4717-82d2-2b8fe339355b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{admin_token}}","type":"text"}],"url":"http://localhost:3001/api/services/service_id_1","description":"Deactivate a service (requires admin privileges)
\n","urlObject":{"path":["api","services","service_id_1"],"host":["http://localhost:3001"],"query":[],"variable":[]}},"response":[{"id":"7edd92d5-595e-4efb-8565-78e0127f294f","name":"Success Response","originalRequest":{"method":"DELETE","header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4e5d959b-e104-4717-82d2-2b8fe339355b"}],"id":"27e897f7-0460-4720-8bdc-da1a6d23c657","description":"Endpoints for managing streaming services
\n","_postman_id":"27e897f7-0460-4720-8bdc-da1a6d23c657"},{"name":"Admin","item":[{"name":"Service Management","item":[{"name":"create Service","id":"1dabf967-112d-4738-b40e-88c68d806aa4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"