Aller au contenu principal

Recherche et filtrage

La plupart des endpoints de liste prennent en charge un paramètre search pour filtrer les résultats :

# 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

Filtrage avec where​

Les endpoints de liste acceptent aussi des conditions where sur les propriétés propres de l'entité. Chaque condition a une colonne (col), une expression (expr) et, sauf pour isNull/isNotNull, une valeur (val). Les conditions sont combinées avec AND :

# Éléments de l'objet personnalisé 3 dont le nom contient "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
exprConditionval
eq, neqégal, non égalvaleur
lt, lte, gt, gtecomparaisonvaleur
like, notLikemotif SQL (joker %, encodé dans l'URL sous la forme %25)motif
in, notIndans / pas dans une listeliste séparée par des virgules : where[0][val]=1,2
isNull, isNotNullvide / non vide—

col doit être une propriété de l'entité : par exemple customObject prend l'identifiant numérique de l'objet personnalisé, pas son alias. Les valeurs de champs personnalisés des éléments personnalisés ne peuvent pas être utilisées comme colonne, et une colonne inconnue fait échouer la requête.