API Reference

The AURA REST API gives you full programmatic access to your property management data. All endpoints return JSON and require authentication.

Authentication

All API requests must include a valid Bearer token in the Authorization header. You can generate API keys from your AURA dashboard under Settings → API Keys.

Base URL

https://api.aura-pm.io/v1

Example authenticated request:

curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://api.aura-pm.io/v1/buildings

Buildings

Manage the properties in your portfolio.

GET /v1/buildings List all buildings
GET /v1/buildings/:id Get building details
POST /v1/buildings Create a building

Example response for GET /v1/buildings:

{
  "data": [
    {
      "id": "bld_01",
      "name": "Aurora Heights",
      "type": "residential",
      "units": 240,
      "occupancy": 0.97,
      "address": "15 Innovation Drive"
    }
  ],
  "meta": { "total": 4, "page": 1 }
}

Units

Access individual rentable spaces within buildings.

GET /v1/buildings/:id/units List units in a building
GET /v1/units/:id Get unit details
PUT /v1/units/:id Update a unit

Maintenance Requests

Create and manage maintenance and service requests submitted by residents or staff.

GET /v1/requests List all requests
POST /v1/requests Create a request
GET /v1/requests/:id Get request details
PATCH /v1/requests/:id Update request status

Request statuses:

Status Description
new Request has been submitted and is awaiting review
assigned A technician or team has been assigned to the request
in_progress Work is currently underway
done The request has been completed and resolved

IoT Sensors

Access real-time and historical data from IoT devices deployed across your properties.

GET /v1/sensors List all sensors
GET /v1/sensors/:id/readings Get sensor readings
Real-Time Data

For live sensor updates, connect to the WebSocket endpoint: wss://api.aura-pm.io/v1/sensors/stream

Residents

Manage resident profiles, contact information, and lease associations.

GET /v1/residents List all residents
POST /v1/residents Create a resident
GET /v1/residents/:id Get resident details
Previous ← Getting Started Next Integrations →