elements_list
Retrieve a filtered list of CMS elements by page, language, definition, or path. Optionally include element values for full data.
Instructions
List elements (id, title, path, page_id, element_definition_id, position). Optional filters: page_id, language_id, language_code, element_definition_id, element_definition_title, page_path, page_path_prefix. Pass include_values=true to include the values hash in the projection (off by default — values clutter list views; use element_get for full shape). Read-only.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | ||
| page_id | No | Filter to elements under this page id | |
| language_id | No | Filter by language id (from languages_list) | |
| language_code | No | Filter by ISO 639-1 language code | |
| element_definition_id | No | Filter by definition id | |
| element_definition_title | No | Filter by definition title (string match) | |
| page_path | No | Filter to elements under this exact page path | |
| page_path_prefix | No | Filter to elements under any page path starting with this prefix | |
| include_values | No | When true, Voog populates each element's values hash AND the MCP projection includes it in the returned list. Default false — values clutter list views; use element_get for full per-element shape. | |
| filters | No | Escape hatch for Voog filter keys not exposed as typed args. Keys MUST match q.element.<attr>.(\$eq|\$cont|\$gteq|\$lteq|\$gt|\$lt|\$in|\$nin|\$starts|\$ends|\$null|\$has). |