List Amenities API
Overview
Retrieves a paginated list of Amenity Master items filtered by category, active status, or search term.
- Endpoint:
/api/hotels/amenities/list - Method:
GET
Request Query Parameters (req.query)
| Field | Type | Required | Description |
|---|---|---|---|
page | Number | No | Page number (Default: 1) |
limit | Number | No | Items per page (Default: 10) |
category | Enum | No | HOTEL, ROOM, GENERAL |
active | Boolean / String | No | Filter by active status |
search | String | No | Search query for name or code |
Request Body Example
{
"page": 1,
"limit": 10,
"category": "ROOM",
"active": true
}
Response Example (200 OK)
{
"success": true,
"message": "Amenities retrieved successfully",
"data": [
{
"id": "a1234567-89ab-cdef-0123-456789abcdef",
"name": "King Bed",
"code": "BED_KING",
"category": "ROOM",
"active": true
}
],
"pagination": {
"totalItems": 1,
"currentPage": 1,
"totalPages": 1,
"pageSize": 10,
"hasNextPage": false,
"hasPreviousPage": false
}
}