API V2 Route: Inventory Beds

Last updated: October 5, 2026

General Details:

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

 

API Response:

Field Name Data Type Notes
id string Globally unique identifier
name string Unique name of Bed
externalCode string The id, if it is configured
description string  
type BedTypeThin  
building BuildingThin  
suite SuiteThin or null  
room RoomThin  

 

Example Collection Response

{
    "entities": [
        {
            "id": "1",
            "name": "Stone Frog Room-1",
            "externalCode": "14St.SF-1-c1",
            "description": "",
            "type": {
                "id": "2",
                "name": "bunk bed"
            },
            "building": {
                "id": "1",
                "name": "14th Street Building",
                "externalCode": "14St"
            },
            "suite": null,
            "room": {
                "id": "1",
                "name": "Stone Frog Room",
                "externalCode": "14St.SF-1"
            }
        },
        {
            "id": "2",
            "name": "Stone Frog Room-2",
            "externalCode": "14St.SF-1-c2",
            "description": "",
            "type": {
                "id": "1",
                "name": "standard bed"
            },
            "building": {
                "id": "1",
                "name": "14th Street Building",
                "externalCode": "14St"
            },
            "suite": null,
            "room": {
                "id": "1",
                "name": "Stone Frog Room",
                "externalCode": "14St.SF-1"
            }
        }
    ],
    "metaData": {
        "agentId": "ab5f95b2-303a-403b-85fd-ab1d0cd8093c",
        "rateLimits": {
            "tenant": {
                "limit": 50,
                "remaining": 49,
                "reset": 1760649005000
            },
            "agent": {
                "limit": 10,
                "remaining": 9,
                "reset": 1760649005000
            }
        },
        "pagination": {
            "offset": 0,
            "limit": 2
        }
    }
}