Skip to content

Query Parameters

All web framework integrations (Axum, Rocket, Actix-web) support the same query parameter format.

GET /api/users?page=2&per_page=20
ParameterTypeDefaultRange
pageu321>= 1
per_pageu32201-100
GET /api/users?sort_by=name&sort_direction=asc
GET /api/users?sort_by=created_at&sort_direction=desc
ParameterValues
sort_byAny field name
sort_directionasc or desc

Filters use the format field:operator:value:

GET /api/users?filter=status:eq:active&filter=age:gt:18

Multiple filter parameters are combined with AND logic.

FilterOperatorDescription
status:eq:activeEqualstatus = 'active'
age:ne:0Not equalage != 0
age:gt:18Greater thanage > 18
age:lt:65Less thanage < 65
age:gte:18Greater or equalage >= 18
age:lte:65Less or equalage <= 65
name:like:%john%LIKEname LIKE '%john%'
name:ilike:%john%ILIKEname ILIKE '%john%'
role:in:admin,modINrole IN ('admin', 'mod')
role:not_in:guestNOT INrole NOT IN ('guest')
age:between:18,65BETWEENage BETWEEN 18 AND 65
deleted_at:is_nullIS NULLdeleted_at IS NULL
email:is_not_nullIS NOT NULLemail IS NOT NULL
bio:contains:rustContainsbio LIKE '%rust%'
GET /api/users?search=john&search_fields=name,email,bio
ParameterDescription
searchSearch query text
search_fieldsComma-separated list of fields to search
GET /api/users?page=1&per_page=10&filter=status:eq:active&filter=age:gt:18&search=developer&search_fields=title,bio&sort_by=created_at&sort_direction=desc