Filter
filter query parameter, which allows clients to specify complex filtering logic. This feature enables precise and efficient querying of resources based on multiple conditions and nested relationships.Filter Syntax
filter parameter in the query string. The format supports logical operators (AND, OR), nested conditions, and a variety of comparison operators.Basic Filter
{
"data": [
{
"id": 1,
"name": "Example Name"
}
],
...pagination data
}Multiple Filters
AND, OR) and parentheses for grouping:{
"data": [
{
"id": 1,
"price": 150,
"category": "Electronics"
}
],
...pagination data
}Nested Filters
{
"data": [
{
"id": 1,
"name": "Example",
}
],
...pagination data
}Supported Operators
| Operator | Example Query | Description |
|---|---|---|
eq | name:eq:Example | Field is equal to the given value |
gt | price:gt:100 | Field is greater than the given value |
lt | price:lt:100 | Field is less than the given value |
gte | price:gte:500 | Field is greater than or equal to the given value |
lte | price:lte:500 | Field is less than or equal to the given value |
like | name:like:john | Field contains the value (case-insensitive) |
contains | name:contains:john | Acts the same as the like operator |
starts_with | email:starts_with:info | Field starts with the given value |
ends_with | email:ends_with:@example.com | Field ends with the given value |
in | status:in:active;pending;suspended | Field matches any of the given values |
not | status:not:eq:active | Negates the filter condition |
Behavior Notes
AND, OR) are case-insensitive.show or with.400 Bad Request response with details of the error.Modified at 2025-08-27 07:38:36