API V2 Route: Inventory Bed Types

General Details:

Endpoint	/api/v2/bed-types and /api/v2/bed-types/<id>
Headers	Authorization: <JWT>
HTTP Methods	GET
Request Body Format	N/A
Response Body Format	JSON
Required Scopes	BED_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 Building Type
tags	string[]	A list of Tag Captions
isDeprecated	boolean
costCode	CostCodeThin

 

Example Collection Response

{
    "entities": [
        {
            "id": "1",
            "name": "standard bed",
            "tags": [
                "Great View"
            ],
            "isDeprecated": false,
            "externalRoomRateCode": "",
            "costCode": {
                "id": "1",
                "name": "Standard Building Bed",
                "code": "BED-01"
            }
        },
        {
            "id": "2",
            "name": "bunk bed",
            "tags": [
                "Great View",
                "Elevator",
                "24hr Security"
            ],
            "isDeprecated": false,
            "externalRoomRateCode": "",
            "costCode": {
                "id": "1",
                "name": "Standard Building Bed",
                "code": "BED-01"
            }
        }
    ],
    "metaData": {
        "agentId": "ab5f95b2-303a-403b-85fd-ab1d0cd8093c",
        "rateLimits": {
            "tenant": {
                "limit": 50,
                "remaining": 49,
                "reset": 1760624399000
            },
            "agent": {
                "limit": 10,
                "remaining": 9,
                "reset": 1760624399000
            }
        },
        "pagination": {
            "offset": 0,
            "limit": 1000
        }
    }
}