Skip to main content

​
Method

GET /v1/ref/room-categories

​
Description

Returns the complete list of active room categories available in the platform. These categories are used when configuring hotel and accommodation products to specify room types like Standard, Deluxe, Suite, etc.

​
Headers

This endpoint is public and does not require authentication.

​
Query Parameters

No query parameters are required. The endpoint returns all active room categories sorted by displayOrder and then by name.

​
Response

{
  "items": [
    {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "code": "standard",
      "name": "Standard Room",
      "description": "Standard accommodation room",
      "displayOrder": 1,
      "isActive": true,
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z"
    },
    {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "code": "deluxe",
      "name": "Deluxe Room",
      "description": "Upgraded room with additional amenities",
      "displayOrder": 2,
      "isActive": true,
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z"
    }
  ]
}

​
Response Fields

​
items
array
required
Array of room category objects.
​
items[].id
string
required
UUID v7 identifier for the room category.
​
items[].code
string
required
Unique code identifier (e.g., “standard”, “deluxe”, “suite”).
​
items[].name
string
required
Human-readable name of the room category.
​
items[].description
string
Optional description of the room category.
​
items[].displayOrder
number
Order for display purposes (lower numbers appear first).
​
items[].isActive
boolean
required
Whether the room category is currently active.
​
items[].createdAt
string
required
ISO 8601 timestamp of when the record was created.
​
items[].updatedAt
string
required
ISO 8601 timestamp of when the record was last updated.

​
Notes

  • Only active room categories (isActive: true) are returned
  • Results are sorted by displayOrder (ascending), then by name (ascending)
  • Inactive or soft-deleted categories are excluded from this endpoint