Filter Operators
Operator | Description |
---|---|
= | Checks if the column value is exactly equal to the given operand. |
!= | Checks if the column value is not equal to the given operand. |
> | Checks if the column value is greater than the given operand. |
< | Checks if the column value is less than the given operand. |
>= | Checks if the column value is greater than or equal to the given operand. |
<= | Checks if the column value is less than or equal to the given operand. |
LIKE | Checks if the column value contains the given operand as a substring. |
STARTS WITH | Checks if the column value begins with the given operand. |
ENDS WITH | Checks if the column value ends with the given operand. |
Field Types and Supported Filters
Field Type | Supported Operators | Usage Notes |
---|---|---|
Text (String) | = , != , LIKE , STARTS WITH , ENDS WITH | Used for names, descriptions, and identifiers. Case-sensitive by default. |
Number | = , != , > , < , >= , <= | Used for numeric values like price, quantity, or ratings. |
Currency | = , != , > , < , >= , <= | Works like a number field but represents monetary values. |
Date & Time | = , != , > , < , >= , <= | Used for timestamps like Created Time, Last Modified Time. |
Dropdown (Single Select) | = , != | Matches against predefined options. |
Dropdown (Multi Select) | LIKE | Checks if a selected value exists within multiple choices. |
= , != | Exact match only, no partial matching. | |
Phone Number | = , != | Exact match only due to format variations. |
URL | = , != , LIKE , STARTS WITH , ENDS WITH | Useful for checking domains, exact links, or protocol types. |
Attachment | = , != , ENDS WITH | Used to filter by file extension (e.g., .pdf , .csv ). |
Auto Number | = , != , > , < , >= , <= | Works like a number but auto-generated. |
User | = , != | Filters by assigned user or creator. |
Percent | = , != , > , < , >= , <= | Works like a number field but represents percentages. |
Rich Text | LIKE , STARTS WITH , ENDS WITH | Filters based on content inside a text block. |
Rating | = , != , > , < , >= , <= | Numeric-based rating values. |
Roll Up | Depends on the aggregated field type | If numeric, supports > , < , etc. If text-based, supports LIKE . |
Examples:
- 1.Filter by Exact Match (
=
)
Request Example:
{
"filter": {
"condition": "where",
"column": "ProductName",
"operator": "=",
"operand_1": "Laptop"
}
}
Explanation: Returns all rows where ProductName
is exactly "Laptop"
.
- 2.Filter by Inequality (
!=
)
Request Example:
{
"filter": {
"condition": "where",
"column": "Status",
"operator": "!=",
"operand_1": "Inactive"
}
}
Explanation: Returns all rows where Status
is not "Inactive"
.
- 3. Filter by Greater Than (
>
)
Request Example:
{
"filter": {
"condition": "where",
"column": "Price",
"operator": ">",
"operand_1": 100
}
}
Explanation: Returns all rows where Price
is greater than 100
.
- 4. Filter by Less Than (
<
)
Request Example:
{
"filter": {
"condition": "where",
"column": "StockQuantity",
"operator": "<",
"operand_1": 50
}
}
Explanation: Returns all rows where StockQuantity
is less than 50
.
- 5. Filter by Greater Than or Equal To (
>=
)
Request Example:
{
"filter": {
"condition": "where",
"column": "Rating",
"operator": ">=",
"operand_1": 4.5
}
}
Explanation: Returns all rows where Rating
is greater than or equal to 4.5
.
- 6. Filter by Less Than or Equal To (
<=
)
Request Example:
{
"filter": {
"condition": "where",
"column": "Discount",
"operator": "<=",
"operand_1": 20
}
}
Explanation: Returns all rows where Discount
is less than or equal to 20
.
- 7.Filter by Partial Match (
LIKE
)
Request Example:
{
"filter": {
"condition": "where",
"column": "Description",
"operator": "LIKE",
"operand_1": "wireless"
}
}
Explanation: Returns all rows where Description
contains "wireless"
anywhere in the text.
- 8.Filter by Prefix (
STARTS WITH
)
Request Example:
{
"filter": {
"condition": "where",
"column": "CustomerName",
"operator": "STARTS WITH",
"operand_1": "John"
}
}
Explanation: Returns all rows where CustomerName
starts with "John"
(e.g., "John Doe"
).
- 9.Filter by Suffix (
ENDS WITH
)
Request Example:
{
"filter": {
"condition": "where",
"column": "FileType",
"operator": "ENDS WITH",
"operand_1": ".csv"
}
}
Explanation: Returns all rows where FileType
ends with ".csv"
(e.g., "data.csv"
).
- Usage Notes
- Filtering is case-sensitive by default. Ensure proper casing when applying filters.
- The
LIKE
operator does not support wildcard characters like%
. It checks for direct substring matches. - Chained filtering using multiple conditions is possible by combining multiple filter objects.