listFormFields
Enumerate form fields with cursor-based pagination and filters. Retrieve field metadata like JSON meta for validators or view flags for editing.
Instructions
List form fields - Paginated enumeration of formfield records. Read-only.
Use when: listing fields on a form. Filter by form_name (text slug — form_fields joins to forms by form_name, not form_id).
Pagination: cursor-based (limit, page). See Rule: Pagination for full cursor/cap/stop semantics.
Filter/sort: property+property_value+property_operator, order_column+order_type. See Rule: Filter operators for the verified-working operator set, silent-drop detection, and derived-field unfilterability.
See also: getFormField (single record by ID).
Returns: { status: "success", total, current_page, total_pages, next_page, prev_page, message: [...records] }. Each record is the full resource object.
Site records and platform master defaults are merged in the response — see Rule: Default-merge models to filter to one and to sort.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Pagination cursor (use next_page from previous response) | |
| limit | No | Records per page (default 25, max 100) | |
| property | No | Column key to filter by (present on the response rows; a wrong name silently returns empty). For multi-condition AND, pass parallel arrays here and in `property_value`/`property_operator` — equal length, Nth entries paired. See Rule: Compound filters. | |
| order_type | No | Sort direction: ASC or DESC | |
| include_meta | No | Opt in to return the `json_meta` longtext blob (UI rendering metadata + per-field validator config). Default stripped — use when adding or editing per-field validators (regexp, stringLength, etc.). See **Rule: Forms** § Field anatomy → `json_meta`. | |
| order_column | No | Column to sort by — a column key present on the response rows (a wrong name silently returns empty) | |
| property_value | No | Value to filter by; array to pair with a `property` array (same length). | |
| property_operator | No | Filter operator (word-form; symbol forms WAF-stripped). Single: eq, ne, lt, lte, gt, gte, like, not_like. CSV: in, not_in, between. Substring: contains, starts_with, ends_with (+not_). Date: year_eq, month_eq, day_eq (+not_), since_days, until_days. Length: length_eq, length_lt, length_gt, length_between. Null: is_set, is_not_set, is_null, is_not_null. Array to pair with a `property` array (same length). See Rule: Filter operators for value shapes. | |
| include_view_flags | No | Opt in to return form-field view-flag columns: `field_input_view`, `field_display_view`, `field_search_view`, `field_email_view`, `field_grid_view`, `field_input_view_admin_only`, plus the 5 alt-label override columns. Default stripped — use when actively editing field visibility. See **Rule: Forms** § Field anatomy. |