Introduction
The field-filters endpoint was added in Gravity Forms 2.4.21.8, it returns the field filters for the specified form. Internally Gravity Forms uses the field filters to populate the search drop down on the entries list page and the filter condition settings on the sales/results pages. You can use the response from this endpoint to create similar features on remote sites or simply use it to help determine which keys and operators to use with the field_filters array of the GET entries search property.
Authentication
See REST API v2 Authentication.
The authenticated user requires the gravityforms_view_entries Gravity Forms capability to use this endpoint.
Method
This endpoint only accepts GET requests.
Path
/gf/v2/forms/[FORM_ID]/field-filters
Required Properties
There are no required properties.
Optional Properties
- _admin_labels – Use the value “1” to include the field admin labels in the response, if configured.
Response [json]
The response will contain a JSON object which contains the field filters for the specified form. Examples can be found below.
Usage Examples
Example 1
This example shows how to get the field filters for form id 577.
Example 2
This example shows how to get the field filters for form id 577 using the field admin labels, if configured.