StartFragment
\nπ¦ API Endpoint: Test Auth Service
\nββββββββββββββββββββββββββββββββββ
\nπΉ Method: GET
πΉ URL: /api/auth/test
ββββββββββββββββββββββββββββββββββ
\nπ Description:
This endpoint is used to verify that the authentication service is up and running. It acts as a health-check for the Auth module.
ββββββββββββββββββββββββββββββββββ
\nπ₯ Request Details
\nHeaders:
\nContent-Type: application/json\n\nBody:
None
ββββββββββββββββββββββββββββββββββ
\nπ€ Success Response (200 OK):
\n{\n \"message\": \"Auth API is working\"\n}\n\nββββββββββββββββββββββββββββββββββ
\nβ Error Response:
No error response is expected from this endpoint under normal conditions.
ββββββββββββββββββββββββββββββββββ
\nπ‘ Usage Tip:
Useful for testing server status or verifying deployment before calling other authentication APIs.
ββββββββββββββββββββββββββββββββββ
\nEndFragment
\n","urlObject":{"protocol":"https","path":["api","auth","test"],"host":["hometruth-ai","onrender","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"db7d7ac6-3252-420f-8197-4b33f4013e96"},{"name":"Register User","id":"b7bf4c64-dfc9-4624-af02-0934186f308d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"fullName\": \"John Doe\",\r\n \"email\": \"john@example.com\",\r\n \"phone\": \"9876543210\",\r\n \"location\": \"Mumbai\",\r\n \"intent\": \"Buy\",\r\n \"password\": \"password123\",\r\n \"role\": \"user\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hometruth-ai.onrender.com/api/auth/register","description":"StartFragment
\nπ¦ API Endpoint: Register User
\nββββββββββββββββββββββββββββββββββ
\nπΉ Method: POST
πΉ URL: /api/auth/register
ββββββββββββββββββββββββββββββββββ
\nπ Description:
This endpoint is used to register a new user in the system. It supports both regular users (buyers, renters, investors) and service providers.
ββββββββββββββββββββββββββββββββββ
\nπ₯ Request Details
\nHeaders:
\nContent-Type: application/json\n\n𧾠Request Body (Regular User):
\n{\n \"fullName\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"phone\": \"9876543210\",\n \"location\": \"Mumbai\",\n \"intent\": \"Buy\",\n \"password\": \"password123\",\n \"role\": \"user\"\n}\n\n𧾠Request Body (Service Provider):
\n{\n \"fullName\": \"Jane Smith\",\n \"email\": \"jane@example.com\",\n \"phone\": \"9876543211\",\n \"location\": \"Delhi\",\n \"password\": \"password123\",\n \"role\": \"provider\",\n \"serviceCategory\": \"plumber\",\n \"experience\": 5,\n \"jobsCompleted\": 50,\n \"baseFee\": 500\n}\n\nββββββββββββββββββββββββββββββββββ
\nπ Request Body Fields
\nπ Fields marked \"Conditional\" are mandatory only when role is _provider_.
ββββββββββββββββββββββββββββββββββ
\nπ€ Success Response (201 Created):
\n{\n \"status\": \"success\",\n \"token\": \"JWT_TOKEN\",\n \"data\": {\n \"user\": {\n \"_id\": \"67b0fcd95d3f...\",\n \"fullName\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"phone\": \"9876543210\",\n \"location\": \"Mumbai\",\n \"intent\": \"Buy\",\n \"role\": \"user\",\n \"avatar\": \"\",\n \"isActive\": true,\n \"createdAt\": \"2026-04-29T10:00:00.000Z\",\n \"updatedAt\": \"2026-04-29T10:00:00.000Z\",\n \"preferences\": {\n \"notificationsEnabled\": true\n },\n \"savedHomes\": [],\n \"viewedHomes\": [],\n \"experience\": 0,\n \"jobsCompleted\": 0,\n \"baseFee\": 0\n }\n }\n}\n\nββββββββββββββββββββββββββββββββββ
\nβ Error Responses
\nπΈ 400 Bad Request (User Already Exists):
\n{\n \"message\": \"User already exists\"\n}\n\nπΈ 500 Internal Server Error:
\n{\n \"error\": \"Error message here\"\n}\n\nββββββββββββββββββββββββββββββββββ
\nπ‘ Usage Tips:
\nEnsure email is unique before sending request
\nAlways validate required fields on frontend
\nFor providers, include all service-related fields
\nStore JWT token securely after successful registration
\nββββββββββββββββββββββββββββββββββ
\nEndFragment
\n","urlObject":{"protocol":"https","path":["api","auth","register"],"host":["hometruth-ai","onrender","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b7bf4c64-dfc9-4624-af02-0934186f308d"},{"name":"Login User","id":"7c0428dd-8fdb-4caa-b1c2-e69777d382d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"status\": \"success\",\r\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\r\n \"data\": {\r\n \"user\": {\r\n \"_id\": \"67b0fcd95d3f...\",\r\n \"fullName\": \"John Doe\",\r\n \"email\": \"john@example.com\",\r\n \"phone\": \"9876543210\",\r\n \"location\": \"Mumbai\",\r\n \"intent\": \"Buy\",\r\n \"role\": \"user\",\r\n \"avatar\": \"\",\r\n \"isActive\": true\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hometruth-ai.onrender.com/api/auth/login","description":"StartFragment
\nπ¦ API Endpoint: Login User
\nββββββββββββββββββββββββββββββββββ
\nπΉ Method: POST
πΉ URL: /api/auth/login
ββββββββββββββββββββββββββββββββββ
\nπ Description:
This endpoint authenticates a registered user and returns a JWT token upon successful login. The token can be used for authorized requests.
ββββββββββββββββββββββββββββββββββ
\nπ₯ Request Details
\nHeaders:
\nContent-Type: application/json\n\n𧾠Request Body:
\n{\n \"email\": \"john@example.com\",\n \"password\": \"password123\"\n}\n\nββββββββββββββββββββββββββββββββββ
\nπ Request Body Fields
\nββββββββββββββββββββββββββββββββββ
\nπ€ Success Response (200 OK):
\n{\n \"status\": \"success\",\n \"token\": \"JWT_TOKEN\",\n \"data\": {\n \"user\": {\n \"_id\": \"67b0fcd95d3f...\",\n \"fullName\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"phone\": \"9876543210\",\n \"location\": \"Mumbai\",\n \"intent\": \"Buy\",\n \"role\": \"user\",\n \"avatar\": \"\",\n \"isActive\": true\n }\n }\n}\n\nββββββββββββββββββββββββββββββββββ
\nβ Error Responses
\nπΈ 400 Bad Request (Missing Credentials):
\n{\n \"message\": \"Please provide email and password\"\n}\n\nπΈ 401 Unauthorized (Invalid Credentials):
\n{\n \"message\": \"Incorrect email or password\"\n}\n\nββββββββββββββββββββββββββββββββββ
\nπ‘ Usage Tips:
\nEnsure correct email and password before sending request
\nStore the returned JWT token securely (e.g., localStorage or cookies)
\nUse the token in Authorization header for protected routes
\nAvoid exposing token in frontend logs or URLs
\nββββββββββββββββββββββββββββββββββ
\nEndFragment
\n","urlObject":{"protocol":"https","path":["api","auth","login"],"host":["hometruth-ai","onrender","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7c0428dd-8fdb-4caa-b1c2-e69777d382d5"},{"name":"Forgot Password","id":"82517d81-f117-4cbc-a00e-4b20f2830cb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"john@example.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hometruth-ai.onrender.com/api/auth/forgot-password","description":"StartFragment
\nπ¦ API Endpoint: Forgot Password
\nββββββββββββββββββββββββββββββββββ
\nπΉ Method: POST
πΉ URL: /api/auth/forgot-password
ββββββββββββββββββββββββββββββββββ
\nπ Description:
This endpoint initiates the password reset process by sending a One-Time Password (OTP) to the user's registered email address. The OTP is valid for 10 minutes.
ββββββββββββββββββββββββββββββββββ
\nπ₯ Request Details
\nHeaders:
\nContent-Type: application/json\n\n𧾠Request Body:
\n{\n \"email\": \"john@example.com\"\n}\n\nββββββββββββββββββββββββββββββββββ
\nπ Request Body Fields
\nββββββββββββββββββββββββββββββββββ
\nπ€ Success Response (200 OK):
\n{\n \"status\": \"success\",\n \"message\": \"OTP sent to email\"\n}\n\nββββββββββββββββββββββββββββββββββ
\nβ Error Responses
\nπΈ 404 Not Found (User Not Found):
\n{\n \"message\": \"No user found with that email\"\n}\n\nπΈ 500 Internal Server Error (Email Sending Failed):
\n{\n \"message\": \"Error sending email. Try again later.\"\n}\n\nββββββββββββββββββββββββββββββββββ
\nπ‘ Usage Tips:
\nEnsure the email is registered before calling this endpoint
\nOTP expires in 10 minutes β prompt user to act quickly
\nAvoid exposing OTP in frontend logs
\nUse this endpoint as the first step in password recovery flow
\nββββββββββββββββββββββββββββββββββ
\nEndFragment
\n","urlObject":{"protocol":"https","path":["api","auth","forgot-password"],"host":["hometruth-ai","onrender","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"82517d81-f117-4cbc-a00e-4b20f2830cb1"},{"name":"Verify OTP","id":"9d12e8b7-1317-484b-bd8a-ad0d4a069231","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"john@example.com\",\r\n \"otp\": \"123456\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hometruth-ai.onrender.com/api/auth/verify-otp","description":"StartFragment
\nπ¦ API Endpoint: Verify OTP
\nββββββββββββββββββββββββββββββββββ
\nπΉ Method: POST
πΉ URL: /api/auth/verify-otp
ββββββββββββββββββββββββββββββββββ
\nπ Description:
This endpoint verifies the One-Time Password (OTP) sent to the userβs registered email. It is a required step before allowing password reset.
ββββββββββββββββββββββββββββββββββ
\nπ₯ Request Details
\nHeaders:
\nContent-Type: application/json\n\n𧾠Request Body:
\n{\n \"email\": \"john@example.com\",\n \"otp\": \"123456\"\n}\n\nββββββββββββββββββββββββββββββββββ
\nπ Request Body Fields
\nββββββββββββββββββββββββββββββββββ
\nπ€ Success Response (200 OK):
\n{\n \"status\": \"success\",\n \"message\": \"OTP verified\"\n}\n\nββββββββββββββββββββββββββββββββββ
\nβ Error Response
\nπΈ 400 Bad Request (Invalid or Expired OTP):
\n{\n \"message\": \"Invalid or expired OTP\"\n}\n\nββββββββββββββββββββββββββββββββββ
\nπ‘ Usage Tips:
\nEnsure OTP is entered correctly and within validity period (10 minutes)
\nThis step must be completed before calling reset password API
\nAvoid multiple failed attempts to prevent security issues
\nββββββββββββββββββββββββββββββββββ
\nEndFragment
\n","urlObject":{"protocol":"https","path":["api","auth","verify-otp"],"host":["hometruth-ai","onrender","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9d12e8b7-1317-484b-bd8a-ad0d4a069231"},{"name":"Reset Password","id":"9f10c0e4-adf0-476c-a825-e2525d94f2cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"john@example.com\",\r\n \"otp\": \"123456\",\r\n \"password\": \"newpassword123\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hometruth-ai.onrender.com/api/auth/reset-password","description":"StartFragment
\nπ¦ API Endpoint: Reset Password
\nββββββββββββββββββββββββββββββββββ
\nπΉ Method: POST
πΉ URL: /api/auth/reset-password
ββββββββββββββββββββββββββββββββββ
\nπ Description:
This endpoint allows users to reset their password using a verified OTP. Upon successful reset, a new JWT token is issued for authentication.
ββββββββββββββββββββββββββββββββββ
\nπ₯ Request Details
\nHeaders:
\nContent-Type: application/json\n\n𧾠Request Body:
\n{\n \"email\": \"john@example.com\",\n \"otp\": \"123456\",\n \"password\": \"newpassword123\"\n}\n\nββββββββββββββββββββββββββββββββββ
\nπ Request Body Fields
\nββββββββββββββββββββββββββββββββββ
\nπ€ Success Response (200 OK):
\n{\n \"status\": \"success\",\n \"token\": \"JWT_TOKEN\",\n \"data\": {\n \"user\": {\n \"_id\": \"67b0fcd95d3f...\",\n \"fullName\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"role\": \"user\"\n }\n }\n}\n\nββββββββββββββββββββββββββββββββββ
\nβ Error Response
\nπΈ 400 Bad Request (Invalid or Expired OTP):
\n{\n \"message\": \"Invalid or expired OTP\"\n}\n\nββββββββββββββββββββββββββββββββββ
\nπ‘ Usage Tips:
\nEnsure OTP is verified before calling this endpoint
\nUse a strong password (recommended: min 6β8 characters with mix of letters & numbers)
\nReplace old token with the new JWT token after reset
\nInvalidate previous sessions on frontend after password change
\nββββββββββββββββββββββββββββββββββ
\nEndFragment
\n","urlObject":{"protocol":"https","path":["api","auth","reset-password"],"host":["hometruth-ai","onrender","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9f10c0e4-adf0-476c-a825-e2525d94f2cf"},{"name":"Recover Password (Temporary Password)","id":"114cc58d-0cff-4e41-b4e4-9aa110af3cc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"john@example.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hometruth-ai.onrender.com/api/auth/recover-password","description":"StartFragment
\nπ¦ API Endpoint: Recover Password (Temporary Password)
\nββββββββββββββββββββββββββββββββββ
\nπΉ Method: POST
πΉ URL: /api/auth/recover-password
ββββββββββββββββββββββββββββββββββ
\nπ Description:
This endpoint generates a temporary password for the user and is primarily designed for frontend integration (e.g., EmailJS). The temporary password can be shared with the user for quick account recovery.
ββββββββββββββββββββββββββββββββββ
\nπ₯ Request Details
\nHeaders:
\nContent-Type: application/json\n\n𧾠Request Body:
\n{\n \"email\": \"john@example.com\"\n}\n\nββββββββββββββββββββββββββββββββββ
\nπ Request Body Fields
\nββββββββββββββββββββββββββββββββββ
\nπ€ Success Response (200 OK):
\n{\n \"status\": \"success\",\n \"message\": \"New password generated\",\n \"data\": {\n \"tempPassword\": \"abc123xy\",\n \"fullName\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"phone\": \"9876543210\"\n }\n}\n\nββββββββββββββββββββββββββββββββββ
\nβ Error Response
\nπΈ 404 Not Found (User Not Found):
\n{\n \"message\": \"No user found with that email\"\n}\n\nββββββββββββββββββββββββββββββββββ
\nπ‘ Usage Tips:
\nUse this endpoint when OTP-based reset is not preferred
\nSend the temporary password securely to the user (email/SMS)
\nPrompt the user to change password immediately after login
\nAvoid exposing the temporary password in frontend logs
\nββββββββββββββββββββββββββββββββββ
\nEndFragment
\n","urlObject":{"protocol":"https","path":["api","auth","recover-password"],"host":["hometruth-ai","onrender","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"114cc58d-0cff-4e41-b4e4-9aa110af3cc2"},{"name":"Get All Service Providers","id":"9f2f00fa-a018-4e53-8fbc-39eef5cfdfef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://hometruth-ai.onrender.com/api/auth/providers","description":"StartFragment
\nπ¦ API Endpoint: Get All Service Providers
\nββββββββββββββββββββββββββββββββββ
\nπΉ Method: GET
πΉ URL: /api/auth/providers
ββββββββββββββββββββββββββββββββββ
\nπ Description:
This endpoint retrieves a list of all users registered as service providers. It is useful for displaying available professionals (e.g., plumbers, electricians, etc.) in the system.
ββββββββββββββββββββββββββββββββββ
\nπ₯ Request Details
\nHeaders:
\nContent-Type: application/json\n\nBody:
None
ββββββββββββββββββββββββββββββββββ
\nπ€ Success Response (200 OK):
\n{\n \"status\": \"success\",\n \"results\": 2,\n \"data\": {\n \"providers\": [\n {\n \"_id\": \"67b0fcd95d3f...\",\n \"fullName\": \"Jane Smith\",\n \"email\": \"jane@example.com\",\n \"phone\": \"9876543211\",\n \"location\": \"Delhi\",\n \"role\": \"provider\",\n \"serviceCategory\": \"plumber\",\n \"experience\": 5,\n \"jobsCompleted\": 50,\n \"baseFee\": 500,\n \"rating\": 0,\n \"isActive\": true\n }\n ]\n }\n}\n\nββββββββββββββββββββββββββββββββββ
\nβ Error Response
\nπΈ 500 Internal Server Error:
\n{\n \"error\": \"Error message here\"\n}\n\nββββββββββββββββββββββββββββββββββ
\nπ‘ Usage Tips:
\nUse this endpoint to build service provider listing pages
\nCan be extended with filters (e.g., category, location, rating)
\nCache results on frontend if data doesnβt change frequently
\nUseful for marketplace or service-booking features
\nββββββββββββββββββββββββββββββββββ
\nEndFragment
\n","urlObject":{"protocol":"https","path":["api","auth","providers"],"host":["hometruth-ai","onrender","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9f2f00fa-a018-4e53-8fbc-39eef5cfdfef"},{"name":"Get All Properties","id":"adbbb199-5a8d-4245-b3fa-55ceaa83afa2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://hometruth-ai.onrender.com/api/properties","description":"StartFragment
\nπ¦ API Endpoint: Get All Properties
\nββββββββββββββββββββββββββββββββββ
\nπΉ Method: GET
πΉ URL: /api/properties
ββββββββββββββββββββββββββββββββββ
\nπ Description:
This endpoint retrieves a list of all property listings available in the system. Results are returned in descending order based on creation date (newest first).
ββββββββββββββββββββββββββββββββββ
\nπ₯ Request Details
\nHeaders:
\nContent-Type: application/json\n\nπ Query Parameters:
None (Can be extended in future for filters like city, price, type, etc.)
Body:
None
ββββββββββββββββββββββββββββββββββ
\nπ€ Success Response (200 OK):
\n{\n \"status\": \"success\",\n \"results\": 2,\n \"data\": {\n \"properties\": [\n {\n \"_id\": \"67b0fcd95d3f...\",\n \"title\": \"3BHK Apartment in Andheri\",\n \"propertyType\": \"Apartment\",\n \"listingType\": \"buy\",\n \"address\": \"123, Sunshine Heights, Andheri West\",\n \"city\": \"Mumbai\",\n \"state\": \"Maharashtra\",\n \"price\": 15000000,\n \"bedrooms\": 3,\n \"bathrooms\": 2,\n \"area\": 1450,\n \"furnishing\": \"Semi\",\n \"ownerName\": \"Rahul Sharma\",\n \"phone\": \"9876543210\",\n \"whatsapp\": \"9876543210\",\n \"email\": \"rahul@example.com\",\n \"images\": [\n \"https://res.cloudinary.com/.../image1.jpg\",\n \"https://res.cloudinary.com/.../image2.jpg\",\n \"https://res.cloudinary.com/.../image3.jpg\"\n ],\n \"healthScore\": 85,\n \"riskLevel\": \"low\",\n \"status\": \"pending\",\n \"lat\": 19.1234,\n \"lng\": 72.8456,\n \"nearbyPlaces\": {\n \"hospitals\": [\n {\n \"name\": \"City Hospital\",\n \"distance\": \"2.5 km\",\n \"lat\": 19.1300,\n \"lng\": 72.8500\n }\n ],\n \"gardens\": [],\n \"temples\": []\n },\n \"createdAt\": \"2026-04-29T10:00:00.000Z\",\n \"updatedAt\": \"2026-04-29T10:00:00.000Z\"\n }\n ]\n }\n}\n\nββββββββββββββββββββββββββββββββββ
\nβ Error Response
\nπΈ 500 Internal Server Error:
\n{\n \"status\": \"error\",\n \"message\": \"Error message here\"\n}\n\nββββββββββββββββββββββββββββββββββ
\nπ‘ Usage Tips:
\nIdeal for property listing pages (home, explore, search)
\nImplement pagination on frontend if dataset grows large
\nFuture enhancements may include filtering, sorting, and search
\nCache results if frequent calls are expected
\nββββββββββββββββββββββββββββββββββ
\nEndFragment
\n","urlObject":{"protocol":"https","path":["api","properties"],"host":["hometruth-ai","onrender","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"adbbb199-5a8d-4245-b3fa-55ceaa83afa2"},{"name":"Create Property","id":"51c287ff-af45-44b6-a80c-142909dcae68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"title\": \"3BHK Apartment in Andheri\",\r\n \"propertyType\": \"Apartment\",\r\n \"listingType\": \"buy\",\r\n \"address\": \"123, Sunshine Heights, Andheri West\",\r\n \"city\": \"Mumbai\",\r\n \"state\": \"Maharashtra\",\r\n \"price\": 15000000,\r\n \"bedrooms\": 3,\r\n \"bathrooms\": 2,\r\n \"area\": 1450,\r\n \"furnishing\": \"Semi\",\r\n \"ownerName\": \"Rahul Sharma\",\r\n \"phone\": \"9876543210\",\r\n \"whatsapp\": \"9876543210\",\r\n \"email\": \"rahul@example.com\",\r\n \"images\": [\r\n \"https://example.com/image1.jpg\",\r\n \"https://example.com/image2.jpg\",\r\n \"https://example.com/image3.jpg\"\r\n ],\r\n \"healthScore\": 85,\r\n \"riskLevel\": \"low\",\r\n \"lat\": 19.1234,\r\n \"lng\": 72.8456,\r\n \"nearbyPlaces\": {\r\n \"hospitals\": [\r\n {\r\n \"name\": \"City Hospital\",\r\n \"distance\": \"2.5 km\",\r\n \"lat\": 19.1300,\r\n \"lng\": 72.8500\r\n }\r\n ],\r\n \"gardens\": [\r\n {\r\n \"name\": \"Central Park\",\r\n \"distance\": \"1.2 km\",\r\n \"lat\": 19.1250,\r\n \"lng\": 72.8470\r\n }\r\n ],\r\n \"temples\": []\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hometruth-ai.onrender.com/api/properties","description":"StartFragment
\nπ¦ API Endpoint: Create Property
\nββββββββββββββββββββββββββββββββββ
\nπΉ Method: POST
πΉ URL: /api/properties
ββββββββββββββββββββββββββββββββββ
\nπ Description:
This endpoint allows users to create a new property listing in the system. It supports detailed property information including location, pricing, images, and nearby places.
ββββββββββββββββββββββββββββββββββ
\nπ₯ Request Details
\nHeaders:
\nContent-Type: application/json\n\n𧾠Request Body:
\n{\n \"title\": \"3BHK Apartment in Andheri\",\n \"propertyType\": \"Apartment\",\n \"listingType\": \"buy\",\n \"address\": \"123, Sunshine Heights, Andheri West\",\n \"city\": \"Mumbai\",\n \"state\": \"Maharashtra\",\n \"price\": 15000000,\n \"bedrooms\": 3,\n \"bathrooms\": 2,\n \"area\": 1450,\n \"furnishing\": \"Semi\",\n \"ownerName\": \"Rahul Sharma\",\n \"phone\": \"9876543210\",\n \"whatsapp\": \"9876543210\",\n \"email\": \"rahul@example.com\",\n \"images\": [\n \"https://example.com/image1.jpg\",\n \"https://example.com/image2.jpg\",\n \"https://example.com/image3.jpg\"\n ],\n \"healthScore\": 85,\n \"riskLevel\": \"low\",\n \"lat\": 19.1234,\n \"lng\": 72.8456,\n \"nearbyPlaces\": {\n \"hospitals\": [\n {\n \"name\": \"City Hospital\",\n \"distance\": \"2.5 km\",\n \"lat\": 19.1300,\n \"lng\": 72.8500\n }\n ],\n \"gardens\": [\n {\n \"name\": \"Central Park\",\n \"distance\": \"1.2 km\",\n \"lat\": 19.1250,\n \"lng\": 72.8470\n }\n ],\n \"temples\": []\n }\n}\n\nββββββββββββββββββββββββββββββββββ
\nπ Request Body Fields
\nπ Images must contain between 3 to 10 URLs if provided.
\nββββββββββββββββββββββββββββββββββ
\nπ€ Success Response (201 Created):
\n{\n \"status\": \"success\",\n \"data\": {\n \"property\": {\n \"_id\": \"67b0fcd95d3f...\",\n \"title\": \"3BHK Apartment in Andheri\",\n \"propertyType\": \"Apartment\",\n \"listingType\": \"buy\",\n \"address\": \"123, Sunshine Heights, Andheri West\",\n \"city\": \"Mumbai\",\n \"state\": \"Maharashtra\",\n \"price\": 15000000,\n \"bedrooms\": 3,\n \"bathrooms\": 2,\n \"area\": 1450,\n \"furnishing\": \"Semi\",\n \"ownerName\": \"Rahul Sharma\",\n \"phone\": \"9876543210\",\n \"whatsapp\": \"9876543210\",\n \"email\": \"rahul@example.com\",\n \"images\": [...],\n \"healthScore\": 85,\n \"riskLevel\": \"low\",\n \"status\": \"pending\",\n \"createdAt\": \"2026-04-29T10:00:00.000Z\",\n \"updatedAt\": \"2026-04-29T10:00:00.000Z\"\n }\n }\n}\n\nββββββββββββββββββββββββββββββββββ
\nβ Error Response
\nπΈ 400 Bad Request (Validation Error):
\n{\n \"status\": \"fail\",\n \"message\": \"Property title is required\"\n}\n\nββββββββββββββββββββββββββββββββββ
\nπ‘ Usage Tips:
\nAlways validate required fields before sending request
\nEnsure image URLs are valid and accessible
\nUse consistent formats for location (lat/lng)
\nKeep healthScore & riskLevel aligned for better UX
\nIdeal for admin panels or property listing dashboards
\nββββββββββββββββββββββββββββββββββ
\nEndFragment
\n","urlObject":{"protocol":"https","path":["api","properties"],"host":["hometruth-ai","onrender","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"51c287ff-af45-44b6-a80c-142909dcae68"},{"name":"Get Single Property","id":"8bb842a7-8e60-4565-a79c-1b6788aec427","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://hometruth-ai.onrender.com/api/properties/:id","description":"StartFragment
\nπ¦ API Endpoint: Get Single Property
\nββββββββββββββββββββββββββββββββββ
\nπΉ Method: GET
πΉ URL: /api/properties/:id
ββββββββββββββββββββββββββββββββββ
\nπ Description:
This endpoint retrieves detailed information of a specific property using its unique ID.
ββββββββββββββββββββββββββββββββββ
\nπ₯ Request Details
\nHeaders:
\nContent-Type: application/json\n\nπ Path Parameters:
\nBody:
None
ββββββββββββββββββββββββββββββββββ
\nπ€ Success Response (200 OK):
\n{\n \"status\": \"success\",\n \"data\": {\n \"property\": {\n \"_id\": \"67b0fcd95d3f...\",\n \"title\": \"3BHK Apartment in Andheri\",\n \"propertyType\": \"Apartment\",\n \"listingType\": \"buy\",\n \"city\": \"Mumbai\",\n \"price\": 15000000,\n \"bedrooms\": 3,\n \"area\": 1450,\n \"ownerName\": \"Rahul Sharma\",\n \"images\": [...],\n \"createdAt\": \"2026-04-29T10:00:00.000Z\"\n }\n }\n}\n\nββββββββββββββββββββββββββββββββββ
\nβ Error Responses
\nπΈ 404 Not Found (Property Not Found):
\n{\n \"status\": \"fail\",\n \"message\": \"Property not found\"\n}\n\nπΈ 400 Bad Request (Invalid ID Format):
\n{\n \"status\": \"fail\",\n \"message\": \"Invalid ID format\"\n}\n\nββββββββββββββββββββββββββββββββββ
\nπ‘ Usage Tips:
\nEnsure the property ID is valid before making the request
\nUse this endpoint for property detail pages
\nCache response for better performance if data is static
\nHandle 404 errors gracefully on frontend (e.g., show βProperty Not Foundβ)
\nββββββββββββββββββββββββββββββββββ
\nEndFragment
\n","urlObject":{"protocol":"https","path":["api","properties",":id"],"host":["hometruth-ai","onrender","com"],"query":[],"variable":[{"type":"any","value":"69f1f88ea6015cef5b6f936a","key":"id"}]}},"response":[],"_postman_id":"8bb842a7-8e60-4565-a79c-1b6788aec427"},{"name":"Update Property","id":"acb7c06d-f167-4d7d-8a66-a5e99c714bb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"https://hometruth-ai.onrender.com/api/properties/:id","description":"StartFragment
\nπ¦ API Endpoint: Update Property
\nββββββββββββββββββββββββββββββββββ
\nπΉ Method: PATCH
πΉ URL: /api/properties/:id
ββββββββββββββββββββββββββββββββββ
\nπ Description:
This endpoint updates an existing property. Only the fields provided in the request body will be modified (partial update supported).
ββββββββββββββββββββββββββββββββββ
\nπ₯ Request Details
\nHeaders:
\nContent-Type: application/json\n\nπ Path Parameters:
\n𧾠Request Body (Partial Update):
\n{\n \"price\": 14000000,\n \"healthScore\": 90,\n \"riskLevel\": \"low\",\n \"status\": \"approved\"\n}\n\nπ Include only the fields you want to update.
\nββββββββββββββββββββββββββββββββββ
\nπ€ Success Response (200 OK):
\n{\n \"status\": \"success\",\n \"data\": {\n \"property\": {\n \"_id\": \"67b0fcd95d3f...\",\n \"title\": \"3BHK Apartment in Andheri\",\n \"price\": 14000000,\n \"healthScore\": 90,\n \"riskLevel\": \"low\",\n \"status\": \"approved\",\n \"updatedAt\": \"2026-04-29T11:00:00.000Z\"\n }\n }\n}\n\nββββββββββββββββββββββββββββββββββ
\nβ Error Response
\nπΈ 400 Bad Request (Validation Error):
\n{\n \"status\": \"fail\",\n \"message\": \"Error message here\"\n}\n\nββββββββββββββββββββββββββββββββββ
\nπ‘ Usage Tips:
\nUse this endpoint for editing property details from admin/user panel
\nAvoid sending unnecessary fields to reduce payload size
\nValidate data before sending update request
\nTrack updatedAt for audit or UI refresh purposes
ββββββββββββββββββββββββββββββββββ
\nEndFragment
\n","urlObject":{"protocol":"https","path":["api","properties",":id"],"host":["hometruth-ai","onrender","com"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"acb7c06d-f167-4d7d-8a66-a5e99c714bb1"},{"name":"Delete Property","id":"e7462820-41b8-491e-8c62-c02d447bb7be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://hometruth-ai.onrender.com/api/properties/:id","description":"StartFragment
\nπ¦ API Endpoint: Delete Property
\nββββββββββββββββββββββββββββββββββ
\nπΉ Method: DELETE
πΉ URL: /api/properties/:id
ββββββββββββββββββββββββββββββββββ
\nπ Description:
This endpoint deletes an existing property listing from the system using its unique ID. Once deleted, the property cannot be recovered.
ββββββββββββββββββββββββββββββββββ
\nπ₯ Request Details
\nHeaders:
\nContent-Type: application/json\n\nπ Path Parameters:
\nBody:
None
ββββββββββββββββββββββββββββββββββ
\nπ€ Success Response (204 No Content):
\n{\n \"status\": \"success\",\n \"data\": null\n}\n\nββββββββββββββββββββββββββββββββββ
\nβ Error Response
\nπΈ 400 Bad Request:
\n{\n \"status\": \"fail\",\n \"message\": \"Error message here\"\n}\n\nββββββββββββββββββββββββββββββββββ
\nπ‘ Usage Tips:
\nUse carefully β deletion is permanent
\nConfirm user action before sending request (UI confirmation recommended)
\nHandle deletion gracefully on frontend (e.g., redirect or refresh list)
\nValidate property ID before making request
\nββββββββββββββββββββββββββββββββββ
\nπ¦ Postman Testing Guide (Professional Setup)
\nββββββββββββββββββββββββββββββββββ
\nπ§ 1. Environment Setup
\nCreate a new environment in Postman
\nAdd variables:
\nbase_url β https://hometruth-ai.onrender.com
token β (set after login)
ββββββββββββββββββββββββββββββββββ
\nπ 2. Authentication Flow
\nRegister or Login first
\nCopy JWT token from response
\nStore in token variable
ββββββββββββββββββββββββββββββββββ
\nπ 3. Using Authorization
\nGo to Authorization Tab
\nSelect Bearer Token
\nEnter:
\n{{token}}\n\nββββββββββββββββββββββββββββββββββ
\nπ€ 4. Sending Requests
\nSet Body β raw β JSON
\nAlways include:
\nContent-Type: application/json\n\nββββββββββββββββββββββββββββββββββ
\nβ οΈ 5. Common Notes
\nCORS is enabled (no frontend issues expected)
\nMax payload size: 50MB
\nAlways validate request body before sending
\nββββββββββββββββββββββββββββββββββ
\nπ 6. Password Reset Flow
\nPOST /api/auth/forgot-password
POST /api/auth/verify-otp
POST /api/auth/reset-password
ββββββββββββββββββββββββββββββββββ
\nπ¦ Model Reference (Quick Overview)
\nββββββββββββββββββββββββββββββββββ
\nπ€ User Model Key Fields
\nfullName, email, password
\nrole (user / admin / provider)
\nserviceCategory (for providers)
\nexperience, jobsCompleted, baseFee
\nsavedHomes, viewedHomes
\nββββββββββββββββββββββββββββββββββ
\nπ Property Model Key Fields
\ntitle, propertyType, listingType
\nprice, area, bedrooms, bathrooms
\nlocation (city, state, lat, lng)
\nimages (3β10 URLs)
\nhealthScore, riskLevel
\nnearbyPlaces (hospitals, gardens, temples)
\nββββββββββββββββββββββββββββββββββ
\nπ¦ Postman Collection
\nββββββββββββββββββββββββββββββββββ
\nπ Import file:HomeTruth_API_Collection.json
βοΈ Contains all endpoints pre-configured
βοΈ Ready for testing & sharing
ββββββββββββββββββββββββββββββββββ
\nπ Support
\nββββββββββββββββββββββββββββββββββ
\nFor issues or improvements:
\nContact development team
\nRaise issue in repository
\nποΈ Last Updated: April 29, 2026
\nββββββββββββββββββββββββββββββββββ
\nEndFragment
\n","urlObject":{"protocol":"https","path":["api","properties",":id"],"host":["hometruth-ai","onrender","com"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"e7462820-41b8-491e-8c62-c02d447bb7be"}]}