list_field_definitions
List all field definitions in a Laserfiche repository, including field names, types, multi-value support, and required status. Essential for preparing field-based queries or updates.
Instructions
List every field definition in the repository.
Use before authoring a field-based search query or preparing a field
update — the response tells you which fields exist, their types
(String, ShortInteger, List, Date, ...), whether they
accept multi-value, whether they're required at the repository level,
and (for List fields) the allowed values.
Independent fields and template-scoped fields are both returned.
Combine with list_template_definitions to see which fields belong
to which template.
Args:
max_results: Page size (default 25, capped by LF_MAX_RESULTS_CEILING).
skip: 0-indexed offset for pagination through large repositories.
summary_only: If True, return only {count, names} instead of the
full OData listing.
Returns: Server's raw OData listing with value (list of field
definitions). Each item includes id, name, fieldType,
isRequired, isMultiValue, listValues, defaultValue,
length, constraint.
On failure: returns {"mode": "error", "error": <slug>, ...}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| max_results | No | Page size (default 25, capped by LF_MAX_RESULTS_CEILING). | |
| skip | No | 0-indexed offset for pagination through large repositories. | |
| summary_only | No | When True, return only {count, names} instead of the full OData listing — useful for 'what's available?' lookups that would otherwise return 30-50 KB of definition payload. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||