API Reference

Rentalot provides a REST API for programmatic access to your account. Use it to sync properties from your PMS, build custom integrations, connect CRM tools, or let AI bots manage your rental operations.

Base URL

https://rentalot.ai/api/v1

Authentication

All API requests require an API key passed in the Authorization header:

Authorization: Bearer your_api_key_here

Generate and manage API keys from Settings > API Keys in your dashboard. See Authentication for details.

Endpoints

Properties

Property Images

Contacts

Contacts are also created automatically when prospects interact with your workflows.

Showings

Conversations

Read-only access for CRM sync and reporting.

Events

Read-only view of your full calendar (showings, synced Google Calendar events, Cal.com events).

Workflows

Messages

Drafts

Follow-ups

Sessions (Pre-Screening)

View and manage prospect submissions from public chat workflows.

Webhooks

Settings

Idempotency

All POST endpoints support an optional Idempotency-Key header. If you send the same key with the same request body within 24 hours, you’ll get the cached response back with an X-Idempotent-Replayed: true header. Use this to safely retry requests without creating duplicates.

Idempotency-Key: your-unique-key-here

Access by Plan

Rate Limits

Rate limits are per API key and vary by plan:

Write operations have additional per-resource daily and monthly caps. See your plan details for specifics.

Rate limit headers are included in every response:

X-RateLimit-Limit: 120
X-RateLimit-Remaining: 87
X-RateLimit-Reset: 1707667200
X-RateLimit-Resource: properties
Retry-After: 3                    (429 responses only)

Pagination

All list endpoints return paginated results:

{
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 142,
    "totalPages": 8
  }
}

Page size is capped by your plan tier (Starter: 50, Pro: 100, Scale: 200).

Errors

All errors follow a consistent format:

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Property not found"
  }
}

Developer Tools

MCP Server

Connect any AI assistant (Claude Code, Claude Desktop, Cursor, Codex, Gemini CLI) to your Rentalot account with our MCP server . 65 tools covering all API resources.

# Claude Code
claude mcp add rentalot -e RENTALOT_API_KEY=ra_your_key -- npx -y @rentalot/mcp-server
 
# Codex
codex mcp add --env RENTALOT_API_KEY=ra_your_key -- npx -y @rentalot/mcp-server
 
# Gemini CLI
gemini mcp add --transport stdio rentalot -- npx -y @rentalot/mcp-server

For Claude Desktop, Cursor, and Windsurf, add to your config JSON:

{
  "mcpServers": {
    "rentalot": {
      "command": "npx",
      "args": ["-y", "@rentalot/mcp-server"],
      "env": { "RENTALOT_API_KEY": "ra_your_key" }
    }
  }
}

See the full setup guide  for all supported clients and config file authentication.

CLI

Manage properties, contacts, showings, and workflows from the terminal with the Rentalot CLI .

go install github.com/Rentalot-ai/rentalot-cli/cmd/rentalot@latest
rentalot --help

Also usable as a Go library:

import "github.com/Rentalot-ai/rentalot-cli/pkg/rentalotcli"

OpenAPI Spec

A machine-readable OpenAPI 3.0 spec is available at:

GET /api/v1/openapi.json

Use it to auto-generate client libraries in any language.