GET /v1/properties/{id}
Get property details
Returns detailed information about a specific property including rooms, statistics, and integrations
Request
GET /v1/properties/{id}
Parameters
[
{
"schema": {
"type": "string"
},
"required": true,
"name": "id",
"in": "path"
}
]
Response
{
"200": {
"description": "Property details retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"data": {
"type": "object",
"properties": {
"property": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"company_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"address": {
"type": [
"string",
"null"
]
},
"latitude": {
"type": [
"number",
"null"
]
},
"longitude": {
"type": [
"number",
"null"
]
},
"property_type": {
"type": "string"
},
"timezone": {
"type": "string"
},
"currency": {
"type": "string"
},
"external_mappings": {},
"images": {
"type": "array",
"items": {
"type": "string"
}
},
"amenities": {
"type": "array",
"items": {
"type": "string"
}
},
"metadata": {},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"rooms": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"room_type": {
"type": "string"
},
"max_occupancy": {
"type": "number"
},
"status": {
"type": "string"
},
"base_price_cents": {
"type": "number"
}
},
"required": [
"id",
"name",
"room_type",
"max_occupancy",
"status",
"base_price_cents"
]
}
},
"integrations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"last_sync_at": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"provider",
"status",
"last_sync_at"
]
}
},
"stats": {
"type": "object",
"properties": {
"total_rooms": {
"type": "number"
},
"available_rooms": {
"type": "number"
},
"occupied_rooms": {
"type": "number"
},
"active_reservations": {
"type": "number"
},
"monthly_revenue": {
"type": "number"
},
"occupancy_rate": {
"type": "number"
}
},
"required": [
"total_rooms",
"available_rooms",
"occupied_rooms",
"active_reservations",
"monthly_revenue",
"occupancy_rate"
]
}
},
"required": [
"id",
"company_id",
"name",
"description",
"address",
"latitude",
"longitude",
"property_type",
"timezone",
"currency",
"images",
"amenities",
"created_at",
"updated_at",
"rooms",
"integrations",
"stats"
]
}
},
"required": [
"property"
]
}
},
"required": [
"success",
"data"
]
}
}
}
},
"403": {
"description": "Access denied to this property"
},
"404": {
"description": "Property not found"
}
}
View in Interactive API Reference