Query Elements
revit_query_elementsFetch paginated Revit element rows with filters (category, family, level, view, and more) after cataloging, returning fields, total count, and hasMore for incremental reads.
Instructions
Read a page of matching element rows after revit_list_catalog.
Returns data with elements (id and values), fields, total, offset, limit and hasMore; values include availability, source and units when available. Lengths use mm, areas m2 and volumes m3; optional geometry uses model mm rounded to one decimal, and unavailable geometry is omitted. Use roomCenterMm for placement inside rooms; a bounding-box centre can lie outside the room. No matches or an offset beyond the result return elements=[]; advance offset while hasMore=true. Call revit_list_catalog first and prefer revit_aggregate_elements for counts and breakdowns. Invalid fields or filters, a missing document, read failure or timeout raise errors; partial data is not returned.
If more than one Revit instance is running, document is required; otherwise any instance may respond.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| view | No | Exact non-template view name from the views catalog, matched case-insensitively, to restrict the element collector. Default null searches the document without a view filter; combines with the other model filters. | |
| level | No | ||
| limit | No | ||
| phase | No | ||
| family | No | ||
| fields | No | ||
| offset | No | ||
| workset | No | ||
| document | No | Case-insensitive substring of the target active document title or file name; default null leaves requests unaddressed, so any instance may respond. Use a unique substring with multiple instances; revit_list_instances instead returns all matching instances, or all instances when omitted. | |
| type_name | No | Exact type name to match, case-insensitively, combined with the other model filters. Default null applies no type filter; discover names with the family-types catalog. | |
| categories | No | ||
| sort_field | No | System field (e.g. id, category, level) or exact localized parameter name to sort before pagination; default id sorts by Revit element ID. Uses sort_direction, with element ID breaking ties for other fields. | id |
| area_scheme | No | Exact area-scheme name from the area-schemes catalog, matched case-insensitively. Default null applies no scheme filter; selecting a scheme restricts results to its areas and combines with the other filters. | |
| sort_direction | No | Sort order: asc or desc, case-insensitively; default asc means ascending. Applies to sort_field before offset and limit. | asc |
| timeout_seconds | No | Positive integer seconds to wait for a result after pickup (120 when omitted); HTTP uses this as its response budget. Expiry raises an error, and increasing it does not override the add-in's execution limits. | |
| include_geometry | No | Whether each query row includes available location, boundingBox and placed-room roomCenterMm coordinates in model millimetres, rounded to one decimal. Default false omits geometry; true increases the response size. | |
| parameter_filters | No | AND-combined objects with an exact localized parameter name in parameter, an operator (equals, contains, greater, less, empty, not-empty, exists), and value for comparisons; default null applies no parameter filters. Numeric values use mm, m2, m3 or other document display units; contains requires text, and empty/not-empty/exists need no value. | |
| pickup_timeout_seconds | No | Positive integer seconds to wait for the add-in to pick up a local or SSH job (300 when omitted); ignored over HTTP. A pickup timeout raises an error but the pending job may still execute later. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||