Skip to main content
API endpoints that allow you to list typically provide two ways of filtering the results.

​
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 the filter 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

Use parentheses when you want to override the default precedence of and before or.

​
Comparators

Use * as the wildcard character with =like=. For example, name=like='*invoice*'.

​
Common Examples

​
Sort

The sort query parameter uses semicolon-separated field:direction pairs:
The direction defaults to asc. If you omit sort, the platform falls back to its resource-specific default order.