# RPM PRO API Documentation

Everything you need to integrate with RPM-PRO v5.9.3.3 — the realtime property management platform for vacation rentals and long-term leases. This documentation covers our REST API, service layer, authentication models, and downloadable Postman packages.

Browse API Reference Download Postman Package
AI agents: Use the machine-readable Markdown docs (agents.html) instead of scraping these HTML pages.

### What this documentation covers

RPM PRO exposes a JSON REST gateway at `/API/` powering the public website, tenant portal booking flows, and third-party integrations. Each area below maps to documented endpoint groups with full field references.

Site & Content API

Settings, CMS blocks, pages, sliders, navigation, FAQs, events, attractions, and contact forms — everything the public marketing site needs.

View Endpoints
Property Catalog API

VR and LTR property listings with images, filters, pagination, and featured photos. Powers vacation-rental and long-term search pages.

View Endpoints
Booking & Quotes API

Availability checks, calendar pricing, quote calculation, coupon validation, and reservation creation with invoice generation.

View Endpoints
Tenant Auth API

Login, registration, activation, session management, and lease applications for the guest/tenant portal.

View Endpoints
40+ REST Endpoints
15 API Controllers
20+ PSR-4 Services

### Built for property managers, by property managers

RPM-PRO is realtime property management software designed alongside rental companies. It unifies long-term leases, vacation bookings, landlord portals, housekeeping, and accounting in one platform — and this API layer lets you connect websites, mobile apps, and partner systems without duplicating business logic.

All API controllers are thin wrappers that delegate to PSR-4 services in `src/RPM/`. When you call an endpoint, you get the same validated data that powers the admin and tenant portals.

Service Registry

Every endpoint in this documentation is generated from the actual service classes and controllers in the codebase — not hand-waved. Request fields, response shapes, and examples match what the API returns today.

### How the API is built

The REST gateway uses the WiseLoop `wlRestService` framework. URLs follow a predictable pattern and map directly to controller methods:

    /API/{controller}/V1/{action}.json

    settingsGet()  → GET  /API/siteSettings/V1/settings.json
    quotePost()    → POST /API/publicBooking/V1/quote.json

What you get in this documentation:

- Complete field lists for every request and response
- Copy-paste cURL and JSON examples
- OpenAPI 3.0 spec and Postman collection (version 5.9.3.3)
- Service layer mapping — which `rpm_*_service()` backs each endpoint
- Admin API guide — authentication + protected `admin*` read endpoints

Admin API Details

### Beyond REST — Integrations

In addition to the wlRest gateway, RPM PRO ships standalone integration endpoints for payments and channel management.

#### Stripe Payments

`/API/stripe-create-intent.html` — PaymentIntent creation with CSRF protection. Webhooks at `stripe-webhook.html`.

#### QuickBooks Online

OAuth flow and webhooks for invoice/bill sync. Admin session required for OAuth start.

#### BookingPal

Channel manager webhook for OTA reservations. Gated by `bookingpalEnabled` setting.

### Ready to integrate?

Start with the full API reference or import our Postman collection.

Open API Reference Get Postman Package

#### For frontend developers

Use `website/src/js/api.js` (`RpmApi`) as the reference client. It mirrors every public endpoint with fetch, error parsing, and URL building.

#### For backend developers

Follow `systemDocuments/myAdmin/coding-standards.md`. New logic goes in `src/RPM/` services — never duplicate SQL in controllers.