API Reference

Build property management features into your application using the RentPager REST API.

REST APIOAuth 2.0JSON

Base URL

https://rentpager.com/api/ai

Authentication

The RentPager API uses OAuth 2.0 for authentication. Your app must request authorization from users before accessing their RentPager data.

1. Register Your Application

First, create an OAuth application in your RentPager dashboard:

Go to Settings → Developer → OAuth Apps
Click "Create New OAuth App"
Provide your app name, redirect URI, and description
Save your Client ID and Client Secret

2. Authorization Flow

Implement the standard OAuth 2.0 authorization code flow:

Redirect users to the authorization URL:

GET https://rentpager.com/oauth/authorize
  ?client_id=YOUR_CLIENT_ID
  &redirect_uri=YOUR_REDIRECT_URI
  &response_type=code
  &scope=read:properties read:payments write:maintenance
  &state=random_state_string

OAuth 2.0 Scopes

Request only the permissions your app needs. Users can see exactly what your app can access.

read:properties

View properties and units

read:renters

View tenant information

read:payments

View payment history and status

read:maintenance

View maintenance requests

write:maintenance

Create and update maintenance requests

write:messages

Send messages to tenants

read:analytics

Access analytics and reports

Properties

GET/api/ai/properties

List all properties for the authenticated user.

Response

{
  "properties": [
    {
      "id": "prop_123",
      "address": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "units": 2,
      "total_value": 1200000,
      "occupancy_rate": 100
    }
  ]
}

GET/api/ai/properties/:id

Get detailed information about a specific property.

Renters

GET/api/ai/renters

List all tenants/renters.

Response

{
  "renters": [
    {
      "id": "rent_123",
      "name": "John Doe",
      "property_id": "prop_123",
      "lease_start": "2024-01-01",
      "lease_end": "2025-01-01",
      "rent_amount": 2400,
      "payment_status": "current"
    }
  ]
}

GET/api/ai/renters/overdue

Get tenants with overdue payments.

Maintenance

GET/api/ai/maintenance

List maintenance requests.

POST/api/ai/maintenance

Create a new maintenance request.

Request Body

{
  "property_id": "prop_123",
  "title": "Broken AC",
  "description": "AC unit not cooling",
  "priority": "high",
  "category": "hvac"
}

Rate Limits

API requests are rate limited to ensure fair usage and system stability.

Rate Limit100 requests per hour

Burst Limit10 requests per second

Rate limit headers are included in all API responses:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640995200

Error Codes

400

Bad Request

Invalid request parameters

401

Unauthorized

Missing or invalid authentication token

403

Forbidden

Insufficient permissions

404

Not Found

Resource not found

429

Too Many Requests

Rate limit exceeded

500

Internal Server Error

Something went wrong on our end

Ready to Start Building?

Create an OAuth application in your dashboard to get your Client ID and Client Secret.

Go to Dashboard