API V2 Route: Inventory Buildings

General Details:

Endpoint	/api/v2/buildings and /api/v2/buildings/<id>
Headers	Authorization: <JWT>
HTTP Methods	GET
Request Body Format	N/A
Response Body Format	JSON
Required Scopes	BUILDINGS_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
externalCode	string	The id, if it is configured
tags	string[]	A list of Tag Captions
description	string
type	BuildingTypeThin or null
address	PhysicalAddress or null

 

Example Collection Response

{
    "entities": [
        {
            "id": "1",
            "name": "14th Street Building",
            "externalCode": "14St",
            "tags": [
                "Elevator",
                "24hr Security"
            ],
            "description": "",
            "type": null,
            "address": {
                "id": "1",
                "streetAddress": "31 Spooner St",
                "streetAddress2": "",
                "city": "Porstmouth",
                "state": "RI",
                "zip": "12345",
                "countryCode": ""
            }
        },
        {
            "id": "2",
            "name": "Swiss Building",
            "externalCode": "SWIS",
            "tags": [
                "Cafeteria"
            ],
            "description": "",
            "type": null,
            "address": {
                "id": "1",
                "streetAddress": "31 Spooner St",
                "streetAddress2": "",
                "city": "Porstmouth",
                "state": "RI",
                "zip": "12345",
                "countryCode": ""
            }
        }
    ],
    "metaData": {
        "agentId": "ab5f95b2-303a-403b-85fd-ab1d0cd8093c",
        "rateLimits": {
            "tenant": {
                "limit": 50,
                "remaining": 49,
                "reset": 1760629023000
            },
            "agent": {
                "limit": 10,
                "remaining": 9,
                "reset": 1760629023000
            }
        },
        "pagination": {
            "offset": 0,
            "limit": 2
        }
    }
}