API Documentation
Integrate RentChaser into your existing systems with our RESTful API. Available on Professional and Enterprise plans.
Quick Links
Getting Started
The RentChaser API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes.
Base URL
https://api.rentchaser.com.au/v1
Authentication
Authenticate your API requests using an API key. You can manage your API keys in your account settings.
Example Request
curl https://api.rentchaser.com.au/v1/tenants \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"Keep your API keys secure! Never share them in publicly accessible areas.
Tenants
Manage tenant records and arrears information.
List all tenants
GET /v1/tenants
Query Parameters:
status
Filter by status: all, arrears, current
limit
Number of results (default: 50, max: 100)
offset
Pagination offset
Example Response
{
"data": [
{
"id": "ten_1a2b3c4d",
"full_name": "John Smith",
"email": "john.smith@example.com",
"phone": "+61412345678",
"current_balance": -850.00,
"days_overdue": 14,
"property": {
"id": "prop_5e6f7g8h",
"address": "123 Main St, Sydney NSW 2000"
},
"created_at": "2026-01-15T10:30:00Z",
"updated_at": "2026-02-09T14:22:00Z"
}
],
"pagination": {
"total": 245,
"limit": 50,
"offset": 0,
"has_more": true
}
}Retrieve a tenant
GET /v1/tenants/:id
Update a tenant
PATCH /v1/tenants/:id
Calls
Initiate AI calls and retrieve call logs.
Initiate an AI call
POST /v1/calls
Request Body
{
"tenant_id": "ten_1a2b3c4d",
"priority": "high",
"custom_message": "Optional custom message to include"
}Response
{
"id": "call_9i8j7k6l",
"tenant_id": "ten_1a2b3c4d",
"status": "queued",
"created_at": "2026-02-09T15:30:00Z"
}List call logs
GET /v1/calls
Query Parameters:
tenant_id
Filter by tenant ID
status
Filter by status: completed, failed, queued
from_date
ISO 8601 date (e.g., 2026-02-01)
Properties
Access property information and associated tenants.
GET /v1/properties
GET /v1/properties/:id
Webhooks
Receive real-time notifications about events in your RentChaser account.
Available Events
call.completed
Triggered when an AI call is completed
tenant.updated
Triggered when tenant information is updated
payment.received
Triggered when a payment is recorded
Configure webhook endpoints in your account settings. We'll send a POST request with the event data.
Rate Limits
API rate limits vary by plan:
Rate limit headers are included in every response. Check X-RateLimit-Remaining to avoid hitting limits.