Skip to content

get_building

Get building information by ID.

Reading a building’s address needs a workspace admin role. Callers without it still get the building, its FAQs and amenities, with address: null and a warnings entry explaining why.

Parameter Type Required Description
buildingId string Yes The ID of the building to retrieve
amenities ConnectionPagination No Pagination options for amenities - ConnectionPagination
faqs ConnectionPagination No Pagination options for FAQs - ConnectionPagination
orientations ConnectionPagination No Pagination options for orientations - ConnectionPagination
zones ConnectionPagination No Pagination options for zones - ConnectionPagination

Use either forward (first/after) or backward (last/before) pagination. The page size is capped at 25.

Field Type Required Description
first number No Number of items to return from the start
after string No Return items after this cursor
last number No Number of items to return from the end
before string No Return items before this cursor
Field Type Description
content ContentItem[] Array of content items returned by the tool - ContentItem
isError boolean Whether the tool execution resulted in an error
Field Type Description
type 'text' Content type (currently only ‘text’ is supported)
text string The text content to display