API Reference

POST/API/auth/V1/login.json Public

Admin API key login; sets wlSession.

{ "adminAPIKey": "your-key", "adminAPISecret": "your-secret" }

HTTP errors: 401 Invalid credentials

GET/API/auth/V1/user.json Admin

Current admin session.

HTTP errors: 401 Unauthorized

GET/API/adminProperties/V1/properties.json Admin

List all properties (LTR+VR by default). Includes archived/off-website unless filtered.

Service: rpm_property_catalog_service()

Roles: super_admin, svc_rep, landlord (read, own properties)

HTTP errors: 401 Unauthorized, 403 Forbidden (wrong role)

GET/API/adminProperties/V1/properties/{id}.json Admin

Single property by ID (LTR or VR).

Roles: super_admin, svc_rep, landlord (read, own properties)

HTTP errors: 404 Property not found

GET/API/adminProperties/V1/property/{id}.json Admin

Alias for single property by ID.

Roles: super_admin, svc_rep, landlord (read, own properties)

HTTP errors: 404 Property not found

POST/API/adminProperties/V1/properties.json Admin

Create LTR or VR property (type field).

Service: CatalogService::adminCreateProperty()

Roles: super_admin

HTTP errors: 400 validation, 401, 403, 409 duplicate name

PUT/API/adminProperties/V1/properties/{id}.json Admin

Update whitelisted property fields.

Roles: super_admin

HTTP errors: 400 unknown fields, 404, 409 duplicate name

PUT/API/adminProperties/V1/property/{id}.json Admin

Alias for property update.

Roles: super_admin

HTTP errors: 400, 404

DELETE/API/adminProperties/V1/properties/{id}.json Admin

Soft-archive property (isArchived=1). Blocked when active future VR reservations exist.

Roles: super_admin

HTTP errors: 404, 409 blocking dependencies

DELETE/API/adminProperties/V1/property/{id}.json Admin

Alias for property archive.

Roles: super_admin

HTTP errors: 404, 409

GET/API/adminInvoices/V1/invoices.json Admin

List invoices with optional filters (excludes drafts unless status=9).

Service: InvoiceService::listInvoices()

Roles: super_admin, svc_rep, landlord (read, own properties)

HTTP errors: 401, 403

GET/API/adminInvoices/V1/invoices/{id}.json Admin

Single invoice with line items and computed totals.

Roles: super_admin, svc_rep, landlord (read, own properties)

HTTP errors: 404 Invoice not found

GET/API/adminInvoices/V1/invoice/{id}.json Admin

Alias for single invoice.

Roles: super_admin, svc_rep, landlord (read, own properties)

HTTP errors: 404 Invoice not found

POST/API/adminInvoices/V1/invoices.json Admin

Create invoice with optional line items.

Service: InvoiceService::adminCreateInvoice()

Roles: super_admin

HTTP errors: 400 validation, 401, 403

PUT/API/adminInvoices/V1/invoices/{id}.json Admin

Update invoice header and append line items.

Service: InvoiceService::adminUpdateInvoice()

Roles: super_admin

HTTP errors: 400, 404

PUT/API/adminInvoices/V1/invoice/{id}.json Admin

Alias for invoice update.

Roles: super_admin

HTTP errors: 404

DELETE/API/adminInvoices/V1/invoices/{id}.json Admin

Cancel invoice (status=5) when no settled payments. Reverses journal entry.

Roles: super_admin

HTTP errors: 404, 409 settled payments

DELETE/API/adminInvoices/V1/invoice/{id}.json Admin

Alias for invoice cancel.

Roles: super_admin

HTTP errors: 404, 409

GET/API/adminTenants/V1/tenants.json Admin

List tenants (paginated, searchable by email/name).

Service: TenantService::listTenants()

Roles: super_admin, svc_rep, landlord (read, own properties)

HTTP errors: 401, 403

GET/API/adminTenants/V1/tenants/{id}.json Admin

Single tenant profile (decrypted contact fields when available).

Roles: super_admin, svc_rep, landlord (read, own properties)

HTTP errors: 404 Tenant not found

GET/API/adminTenants/V1/tenant/{id}.json Admin

Alias for single tenant.

Roles: super_admin, svc_rep, landlord (read, own properties)

HTTP errors: 404 Tenant not found

POST/API/adminTenants/V1/tenants.json Admin

Create tenant account (bcrypt password).

Service: TenantService::adminCreateTenant()

Roles: super_admin

HTTP errors: 400, 409 duplicate email

PUT/API/adminTenants/V1/tenants/{id}.json Admin

Update tenant profile fields.

Service: TenantService::adminUpdateTenant()

Roles: super_admin

HTTP errors: 400, 404

PUT/API/adminTenants/V1/tenant/{id}.json Admin

Alias for tenant update.

Roles: super_admin

HTTP errors: 404

DELETE/API/adminTenants/V1/tenants/{id}.json Admin

Deactivate tenant (isActive=0). Not a hard SQL delete.

Roles: super_admin

HTTP errors: 404

DELETE/API/adminTenants/V1/tenant/{id}.json Admin

Alias for tenant deactivate.

Roles: super_admin

HTTP errors: 404

GET/API/adminReservations/V1/reservations.json Admin

List VR reservations with optional filters.

Service: ReservationService::listReservations()

Roles: super_admin, svc_rep, landlord (read, own properties)

HTTP errors: 401, 403

GET/API/adminReservations/V1/reservations/{id}.json Admin

Single reservation with stay dates.

Roles: super_admin, svc_rep, landlord (read, own properties)

HTTP errors: 404 Reservation not found

GET/API/adminReservations/V1/reservation/{id}.json Admin

Alias for single reservation.

Roles: super_admin, svc_rep, landlord (read, own properties)

HTTP errors: 404 Reservation not found

POST/API/adminReservations/V1/reservations.json Admin

Create VR reservation (admin path; no public CAPTCHA).

Service: ReservationService::createReservation()

Roles: super_admin

HTTP errors: 400 dates unavailable, 401, 403

PUT/API/adminReservations/V1/reservations/{id}.json Admin

Update reservation status and/or stay dates.

Service: ReservationService::adminUpdateReservation()

Roles: super_admin

HTTP errors: 404, 409 dates unavailable

PUT/API/adminReservations/V1/reservation/{id}.json Admin

Alias for reservation update.

Roles: super_admin

HTTP errors: 404

DELETE/API/adminReservations/V1/reservations/{id}.json Admin

Cancel reservation (status=3). Cancels unpaid linked invoices; retains paid invoices.

Roles: super_admin

HTTP errors: 404, 409 already cancelled

DELETE/API/adminReservations/V1/reservation/{id}.json Admin

Alias for reservation cancel.

Roles: super_admin

HTTP errors: 404, 409

GET/API/adminExpenses/V1/expenses.json Admin

List expenses with filters.

Roles: super_admin, svc_rep, landlord (read, own properties)

HTTP errors: 401, 403

GET/API/adminExpenses/V1/expenses/{id}.json Admin

Single expense with line items and computed totals.

Roles: super_admin, svc_rep, landlord (read, own properties)

HTTP errors: 404

POST/API/adminExpenses/V1/expenses.json Admin

Create expense with optional line items.

Roles: super_admin

HTTP errors: 400, 403

PUT/API/adminExpenses/V1/expenses/{id}.json Admin

Update expense header and append line items.

Roles: super_admin

HTTP errors: 400, 404

DELETE/API/adminExpenses/V1/expenses/{id}.json Admin

Cancel expense (status=3) when no settled payments.

Roles: super_admin

HTTP errors: 404, 409 settled payments

GET/API/adminHousekeeping/V1/requests.json Admin

List housekeeping requests.

Roles: super_admin, svc_rep

HTTP errors: 401, 403

GET/API/adminHousekeeping/V1/requests/{id}.json Admin

Single housekeeping request.

Roles: super_admin, svc_rep

HTTP errors: 404

POST/API/adminHousekeeping/V1/requests.json Admin

Create housekeeping request.

Roles: super_admin

HTTP errors: 400, 403

PUT/API/adminHousekeeping/V1/requests/{id}.json Admin

Update housekeeping request fields.

Roles: super_admin

HTTP errors: 404

DELETE/API/adminHousekeeping/V1/requests/{id}.json Admin

Archive request (requestStatus=6).

Roles: super_admin

HTTP errors: 404, 409 already archived

GET/API/adminReports/V1/income.json Admin

Income summary from settled transactions (amountin) in date range.

Roles: super_admin, svc_rep

HTTP errors: 400 missing dates, 403

GET/API/adminReports/V1/occupancy.json Admin

VR occupancy summary — booked nights per property.

Roles: super_admin, svc_rep

HTTP errors: 400, 403

POST/API/publicAuth/V1/login.json Public

Authenticate tenant; sets session (tenantId, propertyId, leaseId).

{ "email": "guest@example.com", "password": "your-password" }

{
  "success": true,
  "user": {
    "tenantId": 15,
    "tenantEmail": "guest@example.com",
    "tenantFirstName": "Jane",
    "tenantLastName": "Guest"
  }
}

HTTP errors: 400 missing fields, 401 invalid credentials, 403 inactive account, 429 lockout (5 failures / 15 min per IP and email)

POST/API/publicAuth/V1/logout.json Public

Destroy tenant session.

GET/API/publicAuth/V1/me.json Session

Current tenant session data.

HTTP errors: 401 Not authenticated

POST/API/publicAuth/V1/register.json Public

Register new tenant; sends activation email.

HTTP errors: 400 validation, 409 email exists, 500 registration failure

GET/API/publicAuth/V1/activate.json Public

Activate account via email link; starts session.

HTTP errors: 400 invalid link, 429 rate limited (10/hour per IP)

GET/API/vrProperties/V1/vrProperties.json Public

List vacation rental properties visible on website.

{
  "items": [{ "propertyId": 2001, "propertyName": "Lake View Cabin", "propertyRate": 189.00, "bedrooms": "3", "featuredImage": "lake.jpg" }],
  "page": 1,
  "limit": 20,
  "total": 45
}

GET/API/vrProperties/V1/vrProperties/{id}.json Public

Single VR property with all catalog fields.

HTTP errors: 404 Property not found

GET/API/vrProperties/V1/vrPropertyImages.json Public

All VR property images.

GET/API/vrProperties/V1/vrPropertyImages/{propertyId}.json Public

Images for one VR property.

GET/API/ltrProperties/V1/ltrProperties.json Public

List long-term rental properties (same filters as VR).

GET/API/ltrProperties/V1/ltrProperties/{id}.json Public

Single LTR property.

HTTP errors: 404 Property not found

GET/API/ltrProperties/V1/ltrPropertyImages/{propertyId}.json Public

Images from propertypictures table.

GET/API/publicBooking/V1/availability/{propertyId}.json Public

Check if date range is bookable with pricing preview.

GET /API/publicBooking/V1/availability/2001.json?dateFrom=2026-08-01&dateTo=2026-08-07

{
  "available": true,
  "message": "",
  "price": 1134.00,
  "nightRates": [{ "date": "2026-08-01", "rate": 189.00 }],
  "intervals": 6,
  "spots": 1
}

HTTP errors: 400 missing propertyId or dates

GET/API/publicBooking/V1/calendar/{propertyId}.json Public

Calendar data: blocked ranges and per-day prices.

{
  "propertyId": 2001,
  "today": "2026-07-13",
  "until": "2027-07-13",
  "ranges": [{ "start": "2026-08-10", "end": "2026-08-15", "type": "reservation" }],
  "baseRate": 189.00,
  "weekendRate": 225.00,
  "dayPrices": { "2026-08-01": 189.00, "2026-08-02": 225.00 }
}

POST/API/publicBooking/V1/quote.json Public

Full quote with fees, taxes, and coupon.

Service: QuoteCalculator::buildQuote()

{
  "propertyId": 2001,
  "dateFrom": "2026-08-01",
  "dateTo": "2026-08-07",
  "adults": 2,
  "children": 0,
  "pets": 0,
  "couponCode": "SUMMER10"
}

{
  "propertyId": 2001,
  "nights": 6,
  "subtotal": 1134.00,
  "discount": 113.40,
  "couponApplied": true,
  "cleaningFee": 150.00,
  "tax": 98.50,
  "total": 1269.10,
  "lineItems": [
    { "label": "6 nights", "amount": 1134.00 },
    { "label": "Discount", "amount": -113.40 },
    { "label": "Cleaning fee", "amount": 150.00 }
  ]
}

POST/API/publicBooking/V1/validateCoupon.json Public

Validate coupon without full quote.

POST/API/publicBooking/V1/book.json Public

Create reservation when tenant session or verified guest email + CAPTCHA.

Service: ApiSecurityPolicy::assertBookingAllowed(), ReservationService::createReservation()

{
  "propertyId": 2001,
  "dateFrom": "2026-08-01",
  "dateTo": "2026-08-07",
  "name": "Jane Guest",
  "email": "jane@example.com",
  "phone": "555-0100",
  "adults": 2
}

{
  "success": true,
  "orderId": 8842,
  "invoiceId": 1205,
  "tenantId": 0,
  "quote": { "total": 1269.10 },
  "message": "Reservation and invoice created. Complete payment via the guest portal."
}

POST/API/leaseApplications/V1/apply.json Session

Submit LTR lease application for logged-in tenant.

HTTP errors: 401 Login required, 400 missing propertyId

GET/API/siteSettings/V1/settings.json Public

Returns public site configuration and API security policy (secrets excluded).

Service: SiteSettingsService::settings(), ApiSecurityPolicy::publicPolicy()

GET /API/siteSettings/V1/settings.json
Accept: application/json

{
  "installUrl": "https://demo.rpm-pro.com/",
  "siteName": "My Rentals",
  "businessEmail": "info@example.com",
  "paymentCurrency": "USD",
  "systemTimeZone": "America/New_York",
  "vrCheckInTime": "16:00",
  "vrCheckOutTime": "10:00",
  "apiPolicy": {
    "apiBookingGuestEnabled": 1,
    "apiBookingRequireLogin": 0,
    "apiCaptchaProvider": "builtin",
    "apiCaptchaSiteKey": "",
    "apiContactCaptchaEnabled": 0,
    "apiSubscribeCaptchaEnabled": 0
  }
}

GET/API/siteContent/V1/content.json Public

All CMS content blocks (single row, all columns).

Service: SiteSettingsService::siteContent()

{
  "indexHeader": "Welcome to Lake Chatuge Rentals",
  "indexSlogan": "Your mountain getaway",
  "c2aText": "Browse our properties",
  "c2aButtonText": "View Rentals",
  "c2aUrl": "/vacation-rental-properties.php"
}

GET/API/siteContent/V1/content/{key}.json Public

Single content block by column key.

GET /API/siteContent/V1/content/indexHeader.json

{ "indexHeader": "Welcome to our rentals" }

GET/API/sitePages/V1/pages.json Public

List active static pages.

{
  "items": [
    {
      "pageId": 11,
      "pageTitle": "Whitewater Rafting",
      "pageUrl": "whitewater-rafting",
      "pageDesc": "Local adventures",
      "pageImage": "",
      "dateUpdated": "2024-06-01 12:00:00"
    }
  ]
}

GET/API/sitePages/V1/pages/{slug}.json Public

Full page by URL slug.

HTTP errors: 404 Page not found

GET/API/siteReviews/V1/reviews.json Public

Property reviews with optional filters.

GET /API/siteReviews/V1/reviews.json?propertyId=42&limit=10

{
  "items": [
    {
      "reviewId": 5,
      "reviewTitle": "Great stay",
      "reviewText": "Beautiful property...",
      "r1": 5, "r2": 5, "r3": 5, "r4": 5, "r5": 5, "r6": 5,
      "propertyId": 42,
      "tenantFirstName": "John",
      "tenantLastName": "Doe",
      "dateCreated": "2025-07-01 10:00:00"
    }
  ]
}

GET/API/siteSliders/V1/sliders.json Public

Homepage slider/carousel items.

GET/API/siteNavigation/V1/menus.json Public

Site navigation menus with nested children.

GET/API/siteFaq/V1/faqs.json Public

Active FAQ entries.

GET/API/siteEvents/V1/events.json Public

List active events.

GET/API/siteEvents/V1/events/{id}.json Public

Single event with full content.

HTTP errors: 404 Event not found

POST/API/siteContact/V1/message.json Public

Submit website contact form; stores message and optional lead.

POST /API/siteContact/V1/message.json
Content-Type: application/json

{
  "senderName": "Jane Smith",
  "senderEmail": "jane@example.com",
  "senderPhone": "555-0100",
  "messageSubject": "Booking inquiry",
  "messageContent": "I would like information about property 42."
}

{ "success": true, "messageId": 128 }

HTTP errors: 400 validation failure (missing fields or honeypot triggered)

POST/API/siteContact/V1/subscribe.json Public

Newsletter / mailing list signup.

{ "email": "subscribe@example.com", "name": "Newsletter Reader" }

{ "success": true }

GET/API/networkBlog/V1/networkBlogPosts.json Public

List blog posts (excerpted content).

GET/API/networkBlog/V1/networkBlogPosts/{id}.json Public

Full blog post.

HTTP errors: 404 Post not found

GET/API/networkBlog/V1/networkBlogByCat/{categoryId}.json Public

Posts filtered by category.

GET/API/networkBlog/V1/networkBlogCategory.json Public

List categories.

GET/API/siteAttractions/V1/attractions.json Public

List attractions, optionally by category.

GET/API/siteAttractions/V1/attractions/{id}.json Public

Single attraction.

HTTP errors: 404 Attraction not found

GET/API/siteAttractions/V1/categories.json Public

Attraction categories.

POST/API/stripe-create-intent.php CSRF

Create Stripe PaymentIntent for invoice payment.

HTTP errors: 403 invalid CSRF, 400 invalid invoice

POST/API/stripe-webhook.php Webhook

Stripe webhook (payment_intent.succeeded, refunds, disputes).

GET/API/quickbooks/oauth-start.php Admin

Start QuickBooks OAuth — requires myAdmin session.

POST/API/bookingpal/webhook.php Webhook

BookingPal inbound OTA reservations.