API Documentation

Build powerful integrations with the NEXUS Property OS RESTful API. Access properties, tenants, leases, financial data, and more.

API Version 2.0

Quick Start

1

Get Your API Key

Navigate to Settings > API Keys in your NEXUS dashboard to generate an API key.

2

Make Your First Request

Use your API key in the Authorization header to authenticate requests.

3

Explore Endpoints

Browse our comprehensive API reference to discover all available endpoints.

Authentication

All API requests require authentication using a Bearer token in the Authorization header.

HTTP Header 
Authorization: Bearer YOUR_API_KEY

Properties API

GET /api/v2/properties

List All Properties

Retrieve a paginated list of all properties in your portfolio.

Parameter Type Description
page integer Page number for pagination (default: 1)
limit integer Number of results per page (default: 20, max: 100)
status string Filter by status: active, inactive, maintenance
Response 
{
  "data": [
    {
      "id": "prop_abc123",
      "name": "Marina Tower A",
      "type": "residential",
      "address": "Dubai Marina, Dubai",
      "units_count": 45,
      "occupied_units": 42,
      "status": "active"
    }
  ],
  "meta": {
    "total": 150,
    "page": 1,
    "limit": 20
  }
}
POST /api/v2/properties

Create Property

Add a new property to your portfolio.

Parameter Type Description
name required string Property name
type required string residential, commercial, mixed
address required object Property address details

Tenants API

GET /api/v2/tenants

List All Tenants

Retrieve all tenants across your properties with optional filters.

GET /api/v2/tenants/{id}

Get Tenant Details

Retrieve detailed information about a specific tenant including lease history and payment records.

PUT /api/v2/tenants/{id}

Update Tenant

Update tenant information such as contact details or emergency contacts.

Payments API

GET /api/v2/payments

List Payments

Retrieve all payment records with filtering by date range, status, and property.

POST /api/v2/payments

Record Payment

Record a new payment from a tenant. Supports cash, cheque, bank transfer, and card payments.

Rate Limits

API requests are rate-limited to ensure fair usage:

  • Standard Plan: 1,000 requests per hour
  • Professional Plan: 5,000 requests per hour
  • Enterprise Plan: Unlimited (contact sales)