Search & Filtering
Most list endpoints support a search parameter for filtering results:
# Simple search
GET /api/contacts?search=john
# Field-specific search
GET /api/contacts?search=email:john@example.com
# Multiple conditions
GET /api/contacts?search=firstname:John%20AND%20city:Paris
Filtering with where​
List endpoints also accept where conditions on the entity's own properties. Each condition has a
column (col), an expression (expr) and, except for isNull/isNotNull, a value (val).
Conditions are combined with AND:
# Items of custom object 3 whose name contains "Order"
GET /api/custom/items?where[0][col]=customObject&where[0][expr]=eq&where[0][val]=3&where[1][col]=name&where[1][expr]=like&where[1][val]=%25Order%25
expr | Condition | val |
|---|---|---|
eq, neq | equal, not equal | value |
lt, lte, gt, gte | comparison | value |
like, notLike | SQL pattern (% wildcard, URL-encoded as %25) | pattern |
in, notIn | in / not in a list | comma-separated list: where[0][val]=1,2 |
isNull, isNotNull | empty / not empty | — |
col must be a property of the entity: for example customObject takes the numeric ID of the
custom object, not its alias. Custom field values of custom items cannot be used as a column, and an
unknown column makes the request fail.