Complete technical documentation, API guides, and integration resources
Essential guides for new users and developers
Complete API documentation and endpoints
Step-by-step integration tutorials
Native mobile app development resources
Frontend integration and web components
Backend integration and server-side SDKs
Retrieve detailed information about a specific property
GET /api/v1/properties/{property_id}
Authorization: Bearer {your_api_token}
Content-Type: application/json
{
"id": "prop_123456",
"address": {
"line1": "123 Victoria Street",
"city": "Manchester",
"postcode": "M1 2AB",
"country": "GB"
},
"type": "flat",
"bedrooms": 2,
"bathrooms": 1,
"epc_rating": "C",
"monthly_rent": 1200.00,
"currency": "GBP",
"status": "let"
}Add a new tenant to your property portfolio
POST /api/v1/tenants
Authorization: Bearer {your_api_token}
Content-Type: application/json
{
"first_name": "John",
"last_name": "Smith",
"email": "john.smith@email.com",
"phone": "+44 7700 900123",
"property_id": "prop_123456",
"lease_start_date": "2024-01-01",
"monthly_rent": 1200.00,
"deposit_amount": 1400.00
}Update the status of a maintenance request
PUT /api/v1/maintenance/{request_id}
Authorization: Bearer {your_api_token}
Content-Type: application/json
{
"status": "completed",
"contractor_id": "contractor_789",
"completion_date": "2024-01-15",
"cost": 150.00,
"notes": "Replaced faulty boiler thermostat"
}Official JavaScript SDK
npm install @redbrick/sdk
const RedBrick = require('@redbrick/sdk');
const client = new RedBrick({
apiKey: 'your_api_key'
});
// Get all properties
const properties = await client.properties.list();
// Create a new tenant
const tenant = await client.tenants.create({
name: 'John Smith',
email: 'john@example.com'
});Official Python SDK
pip install redbrick-sdk
from redbrick import RedBrickClient
client = RedBrickClient(api_key='your_api_key')
# Get all properties
properties = client.properties.list()
# Create a new maintenance request
request = client.maintenance.create({
'property_id': 'prop_123',
'description': 'Leaky faucet',
'priority': 'medium'
})