Documentation

REST Query Params

Use reserved parameters and field suffixes to control list shape and SQL filtering behavior.

Pagination and sorting

ParameterDescription
_limitMaximum number of records.
_startZero-based offset.
_sortSort expression with direction, example field:desc.
select_fieldsComma-separated response field projection.

Comparison suffixes

Common suffixes include _ne, _lt, _lte, _gt, _gte, and _in.

Pattern suffixes

Use _contains, _like, _ilike, _rlike, _llike, and _ncontains to generate LIKE conditions.

Null and empty checks

  • _nn: IS NOT NULL
  • _inn: IS NULL
  • _nie: non-empty string
  • _ie: empty string

Example

GET /api/datalist/metadata/products?category=electronics&price_gte=100&price_lte=500&status_ne=discontinued&name_ilike=pro

All filters are combined with AND in the resulting SQL WHERE clause.