API ReferenceBuildings

Read Building

Info for a specific building

Path parameters

propertyIdstringRequired
The id of the property
buildingIdstringRequired
The id of the building

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"
Specific fields requested in the response. Defaults to all fields.

Response

Expected response to a valid request
createdAtdatetime or null
deletedAtdatetime or null
idstring or nullformat: "uuid"
idempotencyIdstring or nullformat: "uuid"
listingslist of objects or null
namestring or null
numFloorsdouble or null
organizationIdstring or nullformat: "uuid"
propertyobject or null
propertyIdstring or nullformat: "uuid"
readableIdstring or null
unitslist of objects or null
updatedAtdatetime or null