Filters

Filters help you get only the rows you need, for example leads with the "New" status or contracts that expire this month. The API supports the same filters as table views. Which ones fit a specific field is shown next to the field in the database's API docs.

There are two ways to pass a filter in a row list request.

The filters tree

The filters parameter takes JSON. Inside are filter_type (AND or OR) and a filters array. Each condition has field, type, and value.

With field names (user_field_names):

{"filter_type":"AND","filters":[{"field":"Name","type":"equal","value":"test"}]}

Without names, by field ID:

{"filter_type":"AND","filters":[{"field":1,"type":"equal","value":"test"}]}

If filters is passed, the filter__{field}__{filter} and filter_type parameters are ignored.

Short filter

Format: filter__{field}__{filter}=value.

With a field name: filter__Name__equal=test. If there is no field with that name, the search uses field_id.

Without names: filter__field_1__equal=test.

filter_type sets how several short filters are combined. Default: AND, the row must match all of them. OR: matching one is enough. The parameter works when there are two or more filters.

Filter types

In the database docs, some old date filters are marked as deprecated. Don't use them in new requests. Below are the types that aren't marked as deprecated.

The UTC??today example and the numbers in the "Example value" column come from the database docs: they are samples, not a required format for every field.