System-to-System API for Real Estate Inventory Management
All API endpoints require authentication via API client credentials. Include the following headers in every request:
Retrieve detailed information about the real estate company including contact details, social media links, and business information.
{ "success": true, "message": "Company information retrieved successfully", "data": { "company_name": "Delhi Metro Properties Pvt Ltd", "company_address": "123 Connaught Place, New Delhi", "company_country": "India", "company_state": "Delhi", "company_city": "New Delhi", "company_locality": "Connaught Place", "company_zip": "110001", "company_gmaps_link": "https://goo.gl/maps/example", "company_gmaps_iframe": "<iframe src='https://www.google.com/maps/embed?pb=...'></iframe>", "image_url": "https://yourblindersoeinstance.com/storage/company/logo.jpg", "fav_ico_url": "https://yourblindersoeinstance.com/storage/company/favicon.ico", "og_image_url": "https://yourblindersoeinstance.com/storage/company/og-image.jpg", "company_mobile_numbers": "+91-9876543210, +91-9876543211", "company_emails": "info@delhimetroproperties.com, sales@delhimetroproperties.com", "company_gst": "07AADCD1234M1ZX", "company_cin": "U70200DL2020PTC123456", "company_pan": "AADCD1234M", "company_facebook_link": "https://facebook.com/delhimetroproperties", "company_instagram_link": "https://instagram.com/delhimetroproperties", "company_twitter_link": "https://twitter.com/delhimetroproperties", "company_youtube_link": "https://youtube.com/delhimetroproperties", "company_linkedin_link": "https://linkedin.com/company/delhimetroproperties", "company_whatsapp_number": "+91-9876543210" } }
{ "success": false, "message": "Company information not found", "data": null }
{ "success": false, "message": "Unauthorized access", "data": null }
Retrieve a complete list of all cities in the system. The imageUrl field will be returned as a complete URL.
Name | Type | Location | Required | Description | Example |
---|---|---|---|---|---|
search |
string | query | No | Search cities by name. | mumbai |
sort |
string | query | No | Sort field (name, created_at). Default: name. | name |
order |
string | query | No | Sort order (asc, desc). Default: asc. | asc |
{ "success": true, "message": "Cities retrieved successfully", "data": [ { "id": 1, "name": "Mumbai", "image_url": "http://yourdomain.com/storage/cities/mumbai.jpg", "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:30:00Z" }, { "id": 2, "name": "Delhi", "image_url": "http://yourdomain.com/storage/cities/delhi.jpg", "created_at": "2024-01-15T10:31:00Z", "updated_at": "2024-01-15T10:31:00Z" } ], "meta": { "total": 2 } }
{ "success": false, "message": "Unauthorized access", "data": null }
Retrieve a complete list of all projects in the system with their details, city information, project status, and embed codes for digital layouts. For vertical layout projects (is_horizontal_layout = 0), includes project blocks and floors data.
Name | Type | Location | Required | Description | Example |
---|---|---|---|---|---|
search |
string | query | No | Search projects by name or description. | skyline |
city_id |
integer | query | No | Filter projects by city ID. | 1 |
status |
integer | query | No | Filter projects by status (0=upcoming, 1=ongoing, 2=completed). | 1 |
has_digital_layout |
boolean | query | No | Filter projects with digital layout (0 or 1). | 1 |
sort |
string | query | No | Sort field (name, created_at, city_id, status). Default: name. | name |
order |
string | query | No | Sort order (asc, desc). Default: asc. | asc |
{ "success": true, "message": "Projects retrieved successfully", "data": [ { "id": 1, "name": "Skyline Heights Mumbai", "description": "Premium residential project with modern amenities in the heart of Mumbai offering 2BHK and 3BHK apartments with sea view", "address": "Plot No. 123, Sector 15, Navi Mumbai, Maharashtra", "latitude": "19.0760", "longitude": "72.8777", "gmap_iframe": "<iframe src='https://www.google.com/maps/embed?pb=...' width='600' height='450' frameborder='0' allowfullscreen></iframe>", "gmap_link": "https://goo.gl/maps/example123", "image_url": "https://yourblindersoeinstance.com/storage/projects/skyline-heights.jpg", "acres": "5.2", "city_id": 1, "has_digital_layout": 1, "is_horizontal_layout": 1, "status_text": "Ongoing", "embed_code": "<div class=\"digital-layout-embed-container\" style=\"margin: 0 auto 0 auto; width: 100%; padding: 5px;\"><iframe style=\"width: 90vw; height: 100vh;\" src=\"https://yourblindersoeinstance.com/plot-availability-page/1?embed=1\"></iframe></div>", "city": { "id": 1, "name": "Mumbai", "state": "Maharashtra", "country": "India", "latitude": "19.0760", "longitude": "72.8777" }, "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:30:00Z" }, { "id": 2, "name": "Green Valley Residency", "description": "Eco-friendly residential complex with premium villas and apartments in Pune", "address": "Survey No. 45, Baner Road, Pune, Maharashtra", "latitude": "18.5204", "longitude": "73.8567", "gmap_iframe": "<iframe src='https://www.google.com/maps/embed?pb=...' width='600' height='450' frameborder='0' allowfullscreen></iframe>", "gmap_link": "https://goo.gl/maps/example456", "image_url": "https://yourblindersoeinstance.com/storage/projects/green-valley.jpg", "acres": "3.8", "city_id": 2, "has_digital_layout": 0, "is_horizontal_layout": 0, "status_text": "UpComing", "embed_code": null, "city": { "id": 2, "name": "Pune", "state": "Maharashtra", "country": "India", "latitude": "18.5204", "longitude": "73.8567" }, "project_blocks": [ { "id": 1, "name": "Block A", "description": "Residential Block A with premium apartments", "sort_order": 1, "created_at": "2024-01-10T08:20:00Z", "updated_at": "2024-01-10T08:20:00Z", "project_floors": [ { "id": 1, "name": "Ground Floor", "description": "Ground floor with commercial spaces", "sort_order": 1, "created_at": "2024-01-10T08:20:00Z", "updated_at": "2024-01-10T08:20:00Z" }, { "id": 2, "name": "First Floor", "description": "First floor with 2BHK apartments", "sort_order": 2, "created_at": "2024-01-10T08:20:00Z", "updated_at": "2024-01-10T08:20:00Z" } ] } ], "created_at": "2024-01-10T08:20:00Z", "updated_at": "2024-01-10T08:20:00Z" } ], "meta": { "total": 2 } }
{ "success": false, "message": "Unauthorized access", "data": null }
Retrieve leads associated with a specific project including complete lead information, lead histories, and attachments. Supports filtering by creation date range, stage date, lead source, lead stage, and other criteria.
Name | Type | Location | Required | Description | Example |
---|---|---|---|---|---|
project_id |
integer | path | Yes | The ID of the project to get leads for. | 1 |
created_date_start |
string | query | No | Filter leads created from this date (YYYY-MM-DD). | 2024-01-01 |
created_date_end |
string | query | No | Filter leads created until this date (YYYY-MM-DD). | 2024-12-31 |
stage_date_start |
string | query | No | Filter leads by stage date from this date (YYYY-MM-DD). | 2024-01-01 |
stage_date_end |
string | query | No | Filter leads by stage date until this date (YYYY-MM-DD). | 2024-12-31 |
lead_source |
integer | query | No | Filter leads by source. Available values: 1=Not Applicable, 5=Website, 10=WhatsApp, 15=Facebook, 20=Referral, 25=Instagram, 30=LinkedIn, 35=Google Ads, 40=Flyer, 45=Billboard, 50=Newspaper, 55=TV Ad, 65=Cold Call, 70=Email Campaign, 75=Trade Show, 80=Direct Mail, 85=Partner, 90=Walk-In, 95=SMS Campaign, 100=YouTube, 105=Twitter, 110=Pinterest, 115=Snapchat, 135=Real Estate Portal, 140=Property Expo, 145=Broker, 150=Client Referral, 155=Community Event, 170=Forums, 175=Real Estate Blog, 185=Other. | 5 |
lead_stage |
integer | query | No | Filter leads by stage. Available values: 1=Not Applicable, 5=Enquiry Received, 10=Contacted, 15=Qualification, 20=Follow-Up, 25=Interested, 30=Site Visit Scheduled, 35=Site Visit Completed, 40=Negotiation, 45=Document Collection, 50=Under Review, 55=Approved, 80=Closed - Sale Confirmed, 85=Lost, 90=Archived, 100=Re-Engage, 105=Inactive. | 25 |
agent_id |
integer | query | No | Filter leads by assigned agent ID. | 1 |
search |
string | query | No | Search leads by customer name, email, or mobile. | john |
sort |
string | query | No | Sort field (created_date, stage_date, name, total_price). Default: created_date. | created_date |
order |
string | query | No | Sort order (asc, desc). Default: desc. | desc |
{ "success": true, "message": "Leads retrieved successfully", "data": { "leads": [ { "id": 1, "project": { "id": 1, "name": "Skyline Heights Mumbai" }, "plots": "68,69,70", "total_amount": 15000000, "creation_date": "15/01/2024", "current_stage": "Interested", "next_action_date": "20/01/2024", "lead_source": "Website", "additional_notes": "Customer is very interested in the sea view plots", "customer_name": "Rajesh Kumar", "email_address": "rajesh.kumar@email.com", "mobile_number": "+91-9876543210", "gender": "Male", "full_address": "123 Park Street, Kolkata, West Bengal", "pincode": "700016", "date_of_birth": "15/05/1985", "city_town_village": "Kolkata", "designation": "Software Engineer", "about": "Working professional looking for investment property", "downloads": [ "https://yourblindersoeinstance.com/storage/attachments/brochure.pdf", "https://yourblindersoeinstance.com/storage/attachments/floor_plan.pdf" ], "agent_name": "Priya Sharma", "agent_email": "priya.sharma@company.com", "lead_age_days": 5, "deal_value_category": "High Value (50L+)", "lead_histories": [ { "id": 1, "history_date": "15/01/2024", "title": "Initial enquiry received through website", "additional_notes": "Customer interested in 3BHK units with sea view", "before_stage": null, "current_stage": "Enquiry Received", "attachments": [ "https://yourblindersoeinstance.com/storage/attachments/initial_inquiry.pdf" ] }, { "id": 2, "history_date": "16/01/2024", "title": "First follow-up call completed", "additional_notes": "Discussed pricing and availability. Customer wants site visit", "before_stage": "Enquiry Received", "current_stage": "Contacted", "attachments": [] } ] } ] }, "meta": { "total": 1 } }
{ "success": false, "message": "Validation failed", "data": { "errors": { "project_id": [ "The project id field is required." ] } } }
{ "success": false, "message": "Project not found", "data": null }
{ "success": false, "message": "Unauthorized access", "data": null }
Retrieve plots associated with a specific project including complete plot information, booking details, customer information, plot type categories, hold records, and pricing details. Supports filtering by booking status, plot type, block, booking stage, and other criteria.
Name | Type | Location | Required | Description | Example |
---|---|---|---|---|---|
project_id |
integer | path | Yes | The ID of the project to get plots for. | 1 |
booking_status |
integer | query | No | Filter plots by booking status. Available values: 0=Booked, 1=Available, 2=Hold. | 1 |
type_category_id |
integer | query | No | Filter plots by type/category ID. | 5 |
project_block_id |
integer | query | No | Filter plots by project block ID. | 3 |
project_floor_id |
integer | query | No | Filter plots by project floor ID. | 2 |
booking_stage |
integer | query | No | Filter plots by booking stage. Available values: -1=All, 1=Sold, 5=Tentatively_Booked, 10=CIP. | 5 |
plot_no |
string | query | No | Filter plots by plot number (partial match). | A-101 |
is_north_facing |
boolean | query | No | Filter north-facing plots. Values: 0=No, 1=Yes. | 1 |
is_east_facing |
boolean | query | No | Filter east-facing plots. Values: 0=No, 1=Yes. | 1 |
is_south_facing |
boolean | query | No | Filter south-facing plots. Values: 0=No, 1=Yes. | 1 |
is_west_facing |
boolean | query | No | Filter west-facing plots. Values: 0=No, 1=Yes. | 1 |
min_price_range |
integer | query | No | Filter plots with minimum price greater than or equal to this value. | 5000000 |
max_price_range |
integer | query | No | Filter plots with maximum price less than or equal to this value. | 15000000 |
customer_search |
string | query | No | Search in customer name, email, or mobile number for booked plots. | john |
sort |
string | query | No | Sort field (plot_no, price, min_price, max_price, area, booking_date). Default: plot_no. | plot_no |
order |
string | query | No | Sort order (asc, desc). Default: asc. | asc |
{ "success": true, "message": "Plots retrieved successfully", "data": [ { "id": 1, "plot_no": "A-101", "alternate_plot_title": "Premium Corner Unit", "project": { "id": 1, "name": "Skyline Heights Mumbai" }, "status": "Booked", "stage": "Tentatively_Booked", "customer": { "id": 123, "name": "Rajesh Kumar", "mobile": "+91-9876543210" }, "booking": { "id": 456, "booking_date": "15/01/2024", "created_by": "Priya Sharma", "total_price": 15000000, "amount_received": 1500000, "plot_cost": 14500000, "is_token_based": true, "token_start_date": "15/01/2024", "token_end_date": "30/01/2024", "token_notes": "Token valid for 15 days", "token_status": "Expiring 5 days" }, "hold_record": null, "plot_types": ["3BHK", "Premium"], "facing": { "north": true, "east": false, "south": false, "west": true }, "dimensions": { "north": "40 ft", "east": "30 ft", "south": "40 ft", "west": "30 ft" }, "area": "1200 sq ft", "area_1": "1150 sq ft", "pricing": { "general_selling_price": 14500000, "minimum_selling_price": 14000000, "maximum_selling_price": 15000000, "pricing_options": [ { "label": "Base Price", "value": 14000000 }, { "label": "Premium Charges", "value": 500000 } ] }, "additional_notes": "Premium corner plot with park view", "external_link": { "title": "Virtual Tour", "url": "https://example.com/virtual-tour" }, "location": { "latitude": 19.0760, "longitude": 72.8777, "maps_link": "https://maps.google.com/...", "survey_no": "SY/123/A" }, "boundaries": { "north": "Plot A-102", "east": "Main Road", "south": "Plot A-100", "west": "Internal Road" }, "floor_block": { "floor": { "id": 2, "name": "Ground Floor" }, "block": { "id": 3, "name": "Block A" } } } ] ], "meta": { "total": 150, "available": 45, "booked": 90, "hold": 15 } }
Retrieve a complete list of all property types available in the system. Each property type includes project count and image information.
Name | Type | Location | Required | Description | Example |
---|---|---|---|---|---|
search |
string | query | No | Search property types by name. | apartment |
sort |
string | query | No | Sort field (name, created_at, sort_order). Default: sort_order. | name |
order |
string | query | No | Sort order (asc, desc). Default: asc. | asc |
{ "success": true, "message": "Property types retrieved successfully", "data": [ { "id": 1, "name": "Luxury Apartments", "description": "Premium residential apartments with modern amenities", "image_url": "http://yourdomain.com/storage/property-types/apartments.jpg", "sort_order": 1, "project_properties_count": 25, "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:30:00Z" }, { "id": 2, "name": "Independent Villas", "description": "Spacious independent houses with private gardens", "image_url": "http://yourdomain.com/storage/property-types/villas.jpg", "sort_order": 2, "project_properties_count": 12, "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:30:00Z" } ], "meta": { "total": 2 } }
{ "success": false, "message": "Unauthorized access", "data": null }
Retrieve a complete list of all unit types and categories available in the system. These define the various configurations of residential and commercial units.
Name | Type | Location | Required | Description | Example |
---|---|---|---|---|---|
search |
string | query | No | Search types and categories by name. | BHK |
sort |
string | query | No | Sort field (name, created_at, sort_order). Default: sort_order. | name |
order |
string | query | No | Sort order (asc, desc). Default: asc. | asc |
{ "success": true, "message": "Types and categories retrieved successfully", "data": [ { "id": 1, "name": "1 BHK", "description": "One bedroom hall kitchen configuration suitable for small families", "image_url": "http://yourdomain.com/storage/types/1bhk.jpg", "sort_order": 1, "plot_types_and_categories_count": 45, "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:30:00Z" }, { "id": 2, "name": "2 BHK", "description": "Two bedroom hall kitchen configuration ideal for medium families", "image_url": "http://yourdomain.com/storage/types/2bhk.jpg", "sort_order": 2, "plot_types_and_categories_count": 78, "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:30:00Z" }, { "id": 3, "name": "3 BHK", "description": "Three bedroom hall kitchen configuration perfect for large families", "image_url": "http://yourdomain.com/storage/types/3bhk.jpg", "sort_order": 3, "plot_types_and_categories_count": 56, "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:30:00Z" }, { "id": 4, "name": "Duplex", "description": "Two-story apartment with internal staircase", "image_url": "http://yourdomain.com/storage/types/duplex.jpg", "sort_order": 4, "plot_types_and_categories_count": 23, "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:30:00Z" } ], "meta": { "total": 4 } }
{ "success": false, "message": "Unauthorized access", "data": null }