Overview
The Landlord API is what the landlord portal shows, for programs instead of people: your accountant’s software pulling last month’s statement, a spreadsheet tracking payouts, a property app blocking the dates you want to use yourself.
A landlord key is bound to you. There is no landlord to select and no way to widen it — every answer is about the apartments inside your tenures, and your managing agency can see and revoke the key too.
| Base URL | https://api.myrentalcalendar.com/partner/v1/landlord |
| OpenAPI | GET /partner/v1/landlord/openapi.json |
| Auth | Authorization: Bearer hr_live_… — a key from your landlord portal → API access (or one the agency created for you) |
| Rate limit | 60 requests/minute per key |
| Monthly quota | Shared with your agency’s other keys: 50,000 requests per month |
Endpoints
Section titled “Endpoints”| Method & path | Scope | Purpose |
|---|---|---|
GET /me | — | Which agency, which landlord, which scopes and budget |
GET /units | landlord:read:units | Your apartments with their tenures |
GET /units/:slug | landlord:read:units | One apartment |
GET /availability | landlord:read:units | Blocked nights of one apartment |
GET /bookings | landlord:read:units | Anonymised stays inside your tenure |
GET /bookings/:id | landlord:read:units | One stay |
POST /blocks | landlord:write:blocks | Block dates for own use |
DELETE /blocks/:id | landlord:write:blocks | Remove a future block |
GET /statement | landlord:read:finance | Your statement for a period |
GET /payouts | landlord:read:finance | Transfers to you |
GET /invoices | landlord:read:finance | Invoices for stays on your units |
GET /costs | landlord:read:costs | Running costs of your apartments |
GET /cost-categories | landlord:read:costs | Categories you may book against |
POST /costs | landlord:write:costs | Record a cost |
DELETE /costs/:id | landlord:write:costs | Remove a cost you recorded |
GET /documents | landlord:read:documents | Your documents |
GET /documents/:id/download | landlord:read:documents | The file |
GET /messages | landlord:messages | Conversations with the office |
GET /messages/:id | landlord:messages | One conversation |
POST /messages | landlord:messages | Open a conversation |
POST /messages/:id/replies | landlord:messages | Reply |
What you will never see here
Section titled “What you will never see here”- Guest names or contact details. A stay is dates, party size and money. The agency answers to the guest for their data; the API keeps that boundary.
- Other landlords’ units — not even the ones in the same building.
- The agency’s internal cost categories, unless a row is deducted from your payout — a deduction is never hidden.
- Documents the office has not released yet.
Conventions
Section titled “Conventions”Dates are ISO YYYY-MM-DD; stays are half-open [arrival, departure). Amounts
are integers in the agency currency’s minor unit (45000 = AED 450.00). Errors
carry a stable code and a readable title; the list is in
errors & limits. Lists that can grow paginate with
?page=&pageSize=.