Query
You can use the query parameter to filter the results by a search term. The search term is matched against the name of the resource. For example, to list all the projects that contain the word “test” in their name, you can use the following query:Filter
Filters allow for more precise queries on specific fields. The platform uses a SpringFilter-style DSL in thefilter query parameter. For example, to list all projects named test:
Fields
Field names are used directly. Dotted paths traverse related objects or structured fields. For example:category.updatedAt, project.organization.id, features.slug
Inputs
Numbers and booleans are unquoted. Strings, enums, UUIDs, and dates should be single-quoted. For example:status=='ACTIVE'
Operators
| Syntax | Description | Example |
|---|---|---|
and or ; | Both expressions must match | status=='ACTIVE' and createdAt>'2026-01-01' |
or or , | Either expression may match | status=='FAILED' or status=='PENDING' |
( ) | Group expressions | (status=='FAILED' or status=='PENDING') and project.id=='abc123' |
Use parentheses when you want to override the default precedence of
and before or.Comparators
| Syntax | Description | Example |
|---|---|---|
== | Equals | id==5 |
!= | Not equal | status!='ARCHIVED' |
> | Greater than | createdAt>'2026-01-01' |
>= | Greater than or equal | priority>=5 |
< | Less than | pageCount<100 |
<= | Less than or equal | pageCount<=100 |
=like= | Wildcard string match | path=like='*invoice*' |
=in= | Value is in a list | status=in=('FAILED','PENDING') |
is null | Field is null | completedAt is null |
is not null | Field is not null | project.id is not null |
Use
* as the wildcard character with =like=. For example, name=like='*invoice*'.Common Examples
Sort
Thesort query parameter uses semicolon-separated field:direction pairs:
asc. If you omit sort, the platform falls back to its resource-specific default order.