Advanced filtering, search, and field selection for API resources
query
parameter performs full-text search across relevant fields:
filter.field.operator=value
Operator | Description | Example |
---|---|---|
equals | Exact match (case-sensitive) | [email protected] |
not | Not equal to | filter.status.not=inactive |
contains | Contains substring | [email protected] |
startsWith | Starts with string | filter.name.startsWith=John |
endsWith | Ends with string | filter.email.endsWith=.edu |
in | Value in array | filter.status.in=active,pending |
notIn | Value not in array | filter.status.notIn=deleted,archived |
Operator | Description | Example |
---|---|---|
equals | Equal to | filter.score.equals=100 |
not | Not equal to | filter.score.not=0 |
gt | Greater than | filter.score.gt=50 |
gte | Greater than or equal | filter.score.gte=50 |
lt | Less than | filter.score.lt=100 |
lte | Less than or equal | filter.score.lte=100 |
in | Value in array | filter.priority.in=1,2,3 |
Operator | Description | Example |
---|---|---|
equals | Exact date match | filter.createdAt.equals=2024-01-15 |
gt | After date | filter.createdAt.gt=2024-01-01 |
gte | On or after date | filter.lastActivityAt.gte=2024-01-01 |
lt | Before date | filter.createdAt.lt=2024-12-31 |
lte | On or before date | filter.updatedAt.lte=2024-12-31 |
Operator | Description | Example |
---|---|---|
has | Array contains value | filter.tags.has=customer |
hasEvery | Array contains all values | filter.tags.hasEvery=customer,vip |
hasSome | Array contains any value | filter.tags.hasSome=lead,prospect |
isEmpty | Array is empty | filter.tags.isEmpty=true |
Operator | Description | Example |
---|---|---|
equals | Boolean value | filter.isActive.equals=true |
not | Opposite boolean | filter.isVerified.not=true |
select[]
parameter to specify which fields to include in the response: