GET /v1/properties
List company properties
Returns all properties for the authenticated user's company with room counts and statistics
Request
GET /v1/properties
Parameters
[
{
"schema": {
"type": "string",
"default": "1"
},
"required": false,
"name": "page",
"in": "query"
},
{
"schema": {
"type": "string",
"default": "20"
},
"required": false,
"name": "limit",
"in": "query"
},
{
"schema": {
"type": "string"
},
"required": false,
"name": "company_id",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"hotel",
"apartment",
"villa",
"house",
"room"
]
},
"required": false,
"name": "property_type",
"in": "query"
}
]
Response
{
"200": {
"description": "Properties retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"data": {
"type": "object",
"properties": {
"properties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"company_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"address": {
"type": [
"string",
"null"
]
},
"property_type": {
"type": [
"string",
"null"
]
},
"timezone": {
"type": "string"
},
"currency": {
"type": "string"
},
"images": {
"type": "array",
"items": {
"type": "string"
}
},
"amenities": {
"type": "array",
"items": {
"type": "string"
}
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"stats": {
"type": "object",
"properties": {
"total_rooms": {
"type": "number"
},
"available_rooms": {
"type": "number"
},
"occupied_rooms": {
"type": "number"
},
"active_reservations": {
"type": "number"
}
},
"required": [
"total_rooms",
"available_rooms",
"occupied_rooms",
"active_reservations"
]
}
},
"required": [
"id",
"company_id",
"name",
"description",
"address",
"property_type",
"timezone",
"currency",
"images",
"amenities",
"created_at",
"updated_at",
"stats"
]
}
},
"pagination": {
"type": "object",
"properties": {
"page": {
"type": "number"
},
"limit": {
"type": "number"
},
"total": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"has_next": {
"type": "boolean"
},
"has_prev": {
"type": "boolean"
}
},
"required": [
"page",
"limit",
"total",
"total_pages",
"has_next",
"has_prev"
]
}
},
"required": [
"properties",
"pagination"
]
}
},
"required": [
"success",
"data"
]
}
}
}
}
}
View in Interactive API Reference