Get zones (room schedule)
get_zonesLists zones (rooms) with area, perimeter, volume, and totals, filtered by story, category, or search text.
Instructions
Lists zones (rooms) like a room schedule, sorted by story then number: guid, name, number, category, story, construction method (Manual / InnerEdge / ReferenceLine), area, netArea, calculatedArea (after reductions, as in the stamp) in m², perimeter (m), volume (m³), height, bottomElevation, stamp position, plus totals over ALL matching zones. Filter by guids, stories, category or a search text (name or number). Optional: includePolygon, includeQuantities (walls/doors/windows surfaces, corners, extracted areas...), includeRelations (boundary walls/beams, contained elements by type), includeReductions (area reductions with type/percent/area/polygon). For every setting of one zone use get_element_details.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Return at most this many zones (default 500) | |
| zones | No | Only these zones | |
| offset | No | Skip this many zones | |
| search | No | Case-insensitive text contained in the zone name or number | |
| stories | No | Only zones on these story indices (0 = ground floor, negative = basements; see get_stories) | |
| category | No | Only zones of this zone category (localized name or index) | |
| includePolygon | No | Add each zone's outline 'polygon' (inner edges); ReferenceLine zones also get 'referenceLinePolygon' (the measured gross outline) | |
| includeRelations | No | Add boundary walls/beams/curtain wall segments and contained elements by type | |
| includeQuantities | No | Add the full Archicad zone quantity set | |
| includeReductions | No | Add the area reduction polygons (walls, columns, fills, low-height parts) |