API V2 Route: Inventory Rooms

Last updated: October 5, 2026

General Details:

Endpoint /api/v2/rooms and /api/v2/rooms/<id>
Headers Authorization: <JWT>
HTTP Methods GET
Request Body Format N/A
Response Body Format JSON
Required Scopes ROOMS_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  
buildingId string  
suiteId string  

 

API Response:

Field Name Data Type Notes
id string Globally unique identifier
name string Unique name of Room
externalCode string The id, if it is configured
tags string[] A list of Tag Captions
description string  
type RoomTypeThin  
building BuildingThin  
suite SuiteThin or null  

 

Example Collection Response

{
    "entities": [
        {
            "id": "6",
            "name": "R6",
            "externalCode": "SWIS-R6",
            "tags": [
                "Elevator"
            ],
            "description": "",
            "type": {
                "id": "2",
                "name": "standard double"
            },
            "building": {
                "id": "2",
                "name": "Swiss Building",
                "externalCode": "SWIS"
            },
            "suite": null
        },
        {
            "id": "7",
            "name": "R0",
            "externalCode": "SWIS-R0",
            "tags": [
                "Elevator"
            ],
            "description": "",
            "type": {
                "id": "2",
                "name": "standard double"
            },
            "building": {
                "id": "2",
                "name": "Swiss Building",
                "externalCode": "SWIS"
            },
            "suite": null
        }
    ],
    "metaData": {
        "agentId": "ab5f95b2-303a-403b-85fd-ab1d0cd8093c",
        "rateLimits": {
            "tenant": {
                "limit": 50,
                "remaining": 49,
                "reset": 1760647682000
            },
            "agent": {
                "limit": 10,
                "remaining": 9,
                "reset": 1760647683000
            }
        },
        "pagination": {
            "offset": 5,
            "limit": 2
        }
    }
}