Skip to content

Query syntax ​

Every list endpoint accepts the same operator-suffix query string, parsed into a PagedRequest and answered with a PagedResult<T>. It's designed to read naturally in a URL and to be safe — only columns a slice marks queryable are honored.

Filtering ​

?field=operator:value. Combine with &:

?price=gte:10&status=in:active,pending&name=contains:acme
OperatorMeaningExample
eqequals (the default if omitted)status=eq:active
neqnot equalsstatus=neq:archived
gt gte lt ltenumeric / date comparisonsprice=gte:10
inany of (comma-separated)status=in:paid,shipped
containssubstring (case-insensitive)name=contains:acme
startswith / endswithprefix / suffixsku=startswith:ABC

Sorting ​

?sort=field:direction — asc or desc:

?sort=createdAt:desc

Paging ​

?page=2&pageSize=20

A PagedResult<T> returns the page items plus total, page, and pageSize, so the grid can render pagination.

On the frontend ​

useDataGrid builds this query for you and keeps it in the URL, so a list view is shareable. The multi-select <FacetFilter> emits the in: operator. See Build a list.

Questions? Discussions · Contact · NetForge Community is MIT-licensed; get Pro with a plan on the configurator.