GET /v1/rooms
List all rooms
Returns paginated list of rooms for the authenticated user's company
Request
GET /v1/rooms
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": "property_id",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"available",
"occupied",
"maintenance",
"out_of_order"
]
},
"required": false,
"name": "status",
"in": "query"
}
]
Response
{
"200": {
"description": "Rooms retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"data": {
"type": "object",
"properties": {
"rooms": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"property_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"room_type": {
"type": "string"
},
"max_occupancy": {
"type": "number"
},
"bed_count": {
"type": "number"
},
"bathroom_count": {
"type": "number"
},
"size_sqm": {
"type": [
"number",
"null"
]
},
"floor": {
"type": [
"number",
"null"
]
},
"amenities": {
"type": "array",
"items": {
"type": "string"
}
},
"images": {
"type": "array",
"items": {
"type": "string"
}
},
"base_price_cents": {
"type": "number"
},
"status": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"property": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
]
}
},
"required": [
"id",
"property_id",
"name",
"description",
"room_type",
"max_occupancy",
"bed_count",
"bathroom_count",
"size_sqm",
"floor",
"amenities",
"images",
"base_price_cents",
"status",
"created_at",
"updated_at",
"property"
]
}
},
"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": [
"rooms",
"pagination"
]
}
},
"required": [
"success",
"data"
]
}
}
}
}
}
View in Interactive API Reference