Back to Platform Overview
Developer Platform

Build on Arrivolution

A comprehensive RESTful API with real-time WebSocket subscriptions, JWT-based authentication, and OpenAPI documentation — everything you need to integrate property management into your applications.

Six Powerful API Domains

Over 40 REST endpoints spanning every aspect of property management — fully documented with OpenAPI specs, request/response examples, and interactive Swagger UI.

40+
REST Endpoints
6
API Domains
Real-time
WebSocket Subscriptions
OpenAPI
3.0 Specification
Maintenance & Work Orders

Full lifecycle management for maintenance requests — from resident submission with photo uploads and AI-powered visual analysis to vendor assignment, real-time GPS tracking, and completion.

GET/api/maintenance-requests
POST/api/maintenance-requests
PATCH/api/maintenance-requests/:id/status
GET/api/maintenance-requests/:id/history
POST/api/admin/maintenance-requests/:id/assign
Inspections & Reports

Dynamic inspection checklists generated per-unit (bedrooms, bathrooms), photo uploads with notes and condition ratings, e-signature capture, and admin PDF report generation.

GET/api/inspection/checklist?taskId=…
POST/api/inspection/upload
PATCH/api/inspection/upload
POST/api/inspection/complete
POST/api/inspection/report/generate
Showings & Tours

End-to-end self-guided showing workflow — tour requests, prospect pre-screening, ID verification with document analysis, geofence verification, smart lock access codes, and feedback collection.

POST/api/showings/request
POST/api/showings/verify-id
POST/api/showings/verify-geofence
POST/api/showings/start-workflow
POST/api/showings/complete-showing
Events & Community

Create and manage community events (virtual, in-person, hybrid) with RSVP tracking, attendee limits, host info, and real-time attendance counts.

GET/api/events
POST/api/events
POST/api/events/:id/rsvp
GET/api/events/:id/rsvps
Smart Access & Devices

Smart lock integration — device pairing via hosted connect flows, lock/unlock commands, access code management, and webhook-driven state sync.

GET/api/devices
POST/api/devices/connect
GET/api/devices/connect/:id
POST/api/devices/connect/process
Users, Tasks & Onboarding

Resident provisioning, profile management, guided move-in task workflows (utility setup, key delivery, inspections), and property invite code onboarding.

POST/api/auth/provision
GET/api/user/profile
GET/api/user/tasks
POST/api/user/tasks
PATCH/api/user/tasks/:id

Built for Developer Experience

Modern, secure infrastructure designed with developers in mind — from authentication to real-time data flow.

JWT Authentication

Standards-based JWT auth with automatic token refresh. All endpoints validate tokens server-side. Role-based access control for admin, manager, staff, and resident scopes.

Real-Time Subscriptions

WebSocket-powered live updates. Subscribe to changes on tasks, maintenance requests, events, and inspections — no polling required.

Row-Level Security

Database-level row security policies enforce data isolation. Residents only see their own data. Zero-trust architecture with per-org isolation.

Media & Upload Pipeline

Cloud media pipeline with signed uploads, automatic optimization, and CDN delivery. Inspection photos, ID documents, and maintenance images.

AI-Powered Analysis

Automatic visual analysis of maintenance photos to detect issues, safety concerns, and recommended actions. ID document verification with facial matching.

Notifications & Webhooks

Multi-channel notifications via templated email and SMS. Inbound webhooks for smart device events and delivery tracking.

// Authenticate and subscribe to real-time updates
const { token } = await getSession()

// REST API call with JWT
const tasks = await fetch('/api/user/tasks', {
  headers: { 'Authorization': `Bearer ${token}` }
})

// Real-time subscription (no polling needed)
client
  .channel('tasks')
  .on('change', {
    event: '*',
    resource: 'tasks'
  }, (payload) => handleUpdate(payload))
  .subscribe()

Best-in-Class Integrations

Arrivolution connects to the tools property managers and residents already use — with secure, well-documented integration points at every level.

Property Management Systems

Bi-directional sync for property data, resident records, and financials. AES-256-GCM encrypted credential vault with per-organization isolation.

Smart Lock Platforms

Device pairing, lock/unlock, access code management, and webhook-driven state sync. Multi-brand support across leading smart lock manufacturers.

Transactional Email

Templated email delivery for showing confirmations, maintenance updates, invite codes, and inspection reports.

SMS Messaging

A2P-registered messaging for showing invites, access codes, maintenance status updates, and verification codes.

Media & CDN

Signed upload pipeline, automatic image optimization, PDF generation for reports, and global CDN delivery.

3D Virtual Tours

Embedded 3D virtual tours with white-label theming, custom branding, and deep link integration for showings.

Ready to Start Building?

Explore the interactive API docs, grab the OpenAPI spec, or reach out to our engineering team for integration support.