Skip to content

Filter

The filter parameter enables dynamic server-side filtering of paginated results.

Syntax StyleFormatExample
New (compact)(column,operator,value)(status,ne,DELETED)
Old (verbose)(column:name,value:val,type:op)(column:status,value:DELETED,type:exact)

Both syntaxes are supported. New syntax is recommended for readability and brevity.

  • New Syntax - Recommended compact syntax with operators, logical operations, and examples
  • Old Syntax - Deprecated verbose syntax for backwards compatibility
  • Advanced Topics - Value types, SQL injection prevention, and error handling

Simple equality:

(status,ACTIVE)

With operator:

(price,gt,100)

Multiple conditions:

(status,ACTIVE)and(price,gt,100)

Complex grouping:

((status,ACTIVE)or(status,PENDING))and(price,gt,100)

Get started with the New Syntax guide.