Lists the field definitions in your organization. Call it to resolve the field_id values you need before setting field values on a structure — field values are set by ID, not by name.

Narrow the list with filter. Set filter.applies_to to one or more structure type IDs to return only the fields that apply to those types, filter.field_value_types to restrict by value type, and filter.query to search on the field's name. filter.status selects active or archived fields, and filter.field_category selects system or custom fields. filter.mapping_metadata restricts to fields whose mapping carries every key/value pair you supply — the supported keys are field_required and display_on_profiles, and it is most useful combined with filter.applies_to to scope it to one structure type.

Each field carries its field_value_type, which determines the value you supply when creating or replacing a structure, and its structure_settings — the per-structure-type configuration recording whether the field is required for that type and whether it displays on that type's profiles.

Results are paginated. page_size defaults to 25 and accepts 1 to 100; pass the returned page_token to fetch the next page.

📘

A field that is required for a structure's type must be given a value when you create a structure of that type. Filter by applies_to and read structure_settings to find which fields those are before you call the create endpoint.

📘

Custom fields depend on your organization's entitlement. System fields are always returned; custom fields are returned only where your plan includes them, so a field visible in the web app may be absent here.

📘

This endpoint reads field definitions. Creating, updating, and archiving them is not available on the API — manage field definitions in the web app.