API V2 Route: Inventory Room Types

Last updated: October 5, 2026

General Details:

Endpoint	`/api/v2/room-types` and `/api/v2/room-types/<id>`
Headers	`Authorization: <JWT>`
HTTP Methods	`GET`
Request Body Format	`N/A`
Response Body Format	`JSON`
Required Scopes	`ROOM_TYPES_GET`

Supported Request Filters:

These filters should be query parts in the URL string and follow the standard pattern of <baseUrl>?<key>=<filter>&...

Field Name	Filter Type	Notes
`name`	string or String Filter

API Response:

Field Name	Data Type	Notes
id	string	Globally unique identifier
name	string	Unique name of Room Type
capacity	number	The maximum number of beds allowed in this room type
tags	string[]	A list of Tag Captions
isDeprecated	boolean

Example Collection Response

{
    "entities": [
        {
            "id": "1",
            "name": "standard triple",
            "capacity": 3,
            "tags": [],
            "isDeprecated": false
        },
        {
            "id": "2",
            "name": "standard double",
            "capacity": 2,
            "tags": [],
            "isDeprecated": false
        }
    ],
    "metaData": {
        "agentId": "ab5f95b2-303a-403b-85fd-ab1d0cd8093c",
        "rateLimits": {
            "tenant": {
                "limit": 50,
                "remaining": 49,
                "reset": 1760623819000
            },
            "agent": {
                "limit": 10,
                "remaining": 9,
                "reset": 1760623820000
            }
        },
        "pagination": {
            "offset": 0,
            "limit": 1000
        }
    }
}