Search for forms
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
See the search filtering documentation for details about the query syntax. The searchable attributes and the operators each one accepts are listed in the request body below.
Form-specific notes
-
form_definitiontakes a filter on form definitions, e.g. to find forms made from one definition:
{ "form_definition": { "any": { "name": { "equal": "Site Visit Checklist" } } } } -
form_valuesfinds forms that have a value for a field. Identify the field by itsname(ortype) insideform_key_definition, and always include"record_value": {"blank": true}; without it the request fails:{ "form_values": { "any": { "form_key_definition": { "any": { "name": { "equal": "Rating" } } }, "record_value": { "blank": true } } } }To match fields of several types, use
anyontype, e.g."type": { "any": ["option", "combo", "multiple_checkboxes"] }. Field types are listed on Form Definition. -
Linked records (
appointments,contacts,companies,opportunities,projects,tasks,groups,notes,email_messages) take a search filter for that record type withany, using the linked record's reference:
{ "contacts": { "any": { "contact": { "equal": "/v1/contacts/1000" } } } } -
formandform_idmatch the form itself, by reference or by numeric ID.
form_values only tells you whether a form has a value for a field, not what the value is: forms can't be searched by the values of their fields. To find a form by a field value, narrow the forms down with a search like the one above, then check their values.