Tours API
Endpoints for managing property tours.
List Tours
GET /api/v1/tours
Query Parameters
| Parameter | Type | Description |
|---|---|---|
page | integer | Page number (default: 1) |
limit | integer | Items per page (default: 20) |
status | string | Filter by status |
search | string | Search by address |
Response
{
"tours": [
{
"id": "abc123",
"tour_number": "hmrek1t",
"address": "123 Main St",
"city": "San Francisco",
"state": "CA",
"status": "active",
"created_at": "2026-01-15T10:30:00Z"
}
],
"total": 45,
"page": 1,
"pages": 3
}
Get Tour
GET /api/v1/tours/{tourNumber}
Response
{
"id": "abc123",
"tour_number": "hmrek1t",
"address": "123 Main St",
"city": "San Francisco",
"state": "CA",
"zipcode": "94102",
"status": "active",
"mls_number": "ML12345",
"price": 1250000,
"bedrooms": 3,
"bathrooms": 2,
"sqft": 1850,
"images": [...],
"virtual_tour_url": "https://...",
"created_at": "2026-01-15T10:30:00Z",
"updated_at": "2026-01-20T14:00:00Z"
}
Create Tour
POST /api/v1/tours
Request Body
{
"address": "456 Oak Ave",
"city": "Los Angeles",
"state": "CA",
"zipcode": "90001"
}
Update Tour
PUT /api/v1/tours/{tourNumber}
Request Body
{
"status": "active",
"price": 1300000,
"description": "Updated description"
}
Delete Tour
DELETE /api/v1/tours/{tourNumber}
Returns 204 No Content on success.