Platform
Build on top of the most advanced lettings API
Yorlet is the most advanced lettings API on the market. Build your own lettings platform, custom functionality, or integrate with Yorlet to enhance your existing software.
{
"id": "cus_dfjkf03jf2k0kf",
"name": "John Doe",
"email": "[email protected]",
...
}RESTful API
A complete, well-documented API covering every aspect of lettings — from tenancies and payments to compliance.
Webhooks and events
Subscribe to real-time events and react instantly to changes across your portfolio.
Secure by default
OAuth 2.0, scoped API keys, and granular permissions keep your data safe at every layer.
Developer docs
Comprehensive guides, API references, and quickstart tutorials to get you building fast.
One API for the entire lettings lifecycle
Yorlet exposes every part of the lettings workflow through a single, consistent API. Whether you're building from scratch or integrating into an existing stack, the platform adapts to your architecture.
A complete RESTful API
Manage tenancies, customers, payments, properties, and compliance through predictable, resource-oriented endpoints. Every object in Yorlet is accessible via the API.
Core capabilities
Full CRUD for all resources
Cursor-based pagination
Filtering and search
Expandable objects
Idempotent requests
Metadata support
API Explorer
v1/v1/tenancies/ten_1N4xLk2eZv
Response
200 OK{
"id": "ten_1N4xLk2eZv",
"object": "tenancy",
"status": "active",
"property": "prop_8Qh2bR",
"rent": 1250,
"currency": "gbp",
"interval": "month",
"start_date": "2025-03-01",
"customers": [
"cus_4mKp9Xt..."
]
}Real-time webhooks and events
React to changes the moment they happen. Yorlet fires webhooks for every meaningful event — from payment receipts to tenancy status changes — so your systems stay in sync.
Subscribe to granular event types
Signed payloads for verification
Automatic retries with exponential backoff
Event logs and delivery history
Webhook events
SDKs and developer tools
Get up and running quickly with official client libraries, a CLI for local development, and a sandbox environment for safe testing.
Official Node.js and Python SDKs
CLI for local testing and debugging
Sandbox environment with test data
OpenAPI spec for code generation
app.js
const Yorlet = require('yorlet'); const yorlet = Yorlet('sk_live_...VxK9'); const tenancy = await yorlet.tenancies.create({ property: 'prop_8Qh2bR', rent: 1250, currency: 'gbp', interval: 'month', }); // ten_1N4xLk2eZv
Authentication and security
Fine-grained access controls and industry-standard authentication give you full control over who accesses what — and when.
Security features
OAuth 2.0 flows
Scoped API keys
Role-based access control
Rate limiting
Audit logging
IP allowlisting
API keys
| Name | Key | Scope | Created |
|---|---|---|---|
| Production | sk_live_...VxK9 | Full access | Jan 12, 2025 |
| Staging | sk_test_...m3Jp | Full access | Jan 12, 2025 |
| Read-only | sk_live_...hN21 | Read | Mar 4, 2025 |
Everything you need to build on Yorlet
API
RESTful endpoints
Pagination and filtering
Idempotency keys
Versioned releases
Metadata on all objects
Events
Webhook endpoints
Event types catalogue
Signed payloads
Automatic retries
Delivery logs
Developer tools
Node.js and Python SDKs
Command-line interface
Sandbox environment
OpenAPI specification
Security
OAuth 2.0 authentication
Scoped API keys
Role-based permissions
Audit trail