LuxiaHomes REST API

1. Introduction

The LuxiaHomes API allows Enterprise and Pro+ users to read, write, and update data programmatically, enabling seamless synchronization with external ERPs, data providers, or custom CRM solutions. All data is transferred over HTTPS and uses JSON format.

2. Authentication (API Keys)

Authentication is done via a Bearer Token supplied in the Authorization header of every request. You can generate and manage your API keys from your Admin Dashboard under the 'API Settings' tab.

GET /listings
Host: api.luxiahomes.com/v1
Authorization: Bearer YOUR_SECRET_API_KEY
                    

3. Listings Management

Retrieve, create, and update property listings. Remember to use the required property schema fields.

3.1. Retrieve All Listings

GET /listings?status=active&limit=100
// Success Response (200)
{
    "data": [
        {"id": 123, "title": "Luxury Apartment", ...},
        // ...
    ],
    "meta": {"total": 500, "page": 1}
}
                    

3.2. Create New Listing

POST /listings
// Request Body Example:
{
    "title": "New Penthouse Listing",
    "price": 450000,
    "currency": "EUR",
    "location": "Alanya, TR"
}
                    

4. Webhooks

Set up webhooks to receive real-time notifications when a key event occurs (e.g., new lead captured, property sold, subscription status change).

Event: listing.updated
Event: lead.created
Event: billing.invoice_pending