Skip to content

Where Filter

Filter Conditions (where, whereNot, etc.)

Description: API endpoints support advanced filtering through structured condition arrays. These filters allow precise control over which records are included in the response.


Supported Filter Keys

Filter Key Format Description
where [[field, operator, value], ...] Simple comparisons using operators like ==, >, <, etc.
whereNot [[field, value], ...] Negated equality comparisons (!=)
whereIn [[field, [value1, value2, ...]], ...] Field must match one of the values in the list
whereNotIn [[field, [value1, value2, ...]], ...] Field must not match any of the values in the list
whereBetween [[field, [min, max]], ...] Field value must be within the range [min, max]
whereNotBetween [[field, [min, max]], ...] Field value must be outside the range [min, max]

Operators Supported in where

  • "==" or "=": Equal to
  • "!=": Not equal to
  • ">" / "<" / ">=" / "<=": Numeric comparisons
  • "like": Case-sensitive substring match using SQL-style % wildcard

Example Usage

{
  "where": [
    ["login", ">", 1000],
    ["name", "like", "John%"]
  ],
  "whereNot": [
    ["group", "admin"]
  ],
  "whereIn": [
    ["status", ["active", "pending"]]
  ],
  "whereBetween": [
    ["balance", [1000, 5000]]
  ]
}