Skip to main content
Filtering is a powerful way to reduce the amount of data returned by an API call. The endpoints will document the available filtering options.

​
Basic Filtering

Simple key-value query parameters for common use cases.

​
Example

​
Characteristics

  • Easy to use and efficient.
  • Parameter names may represent logical filters, not necessarily direct object fields.
  • Best suited for equality or numeric comparisons (=, <, >).

​
Advanced filtering

For more expressive queries, advanced filtering is available via the filter[…] syntax.

​
Example

​
Rules

  • Filter keys must correspond to actual fields on the resource.
  • Interpretation of operators (=, LIKE, etc.) is documented per API.
  • Designed for flexible matching and multi-field queries.

​
Combining filters

Both approaches can be used together.

​
Example

This means:
  • Status matches active
  • AND gross amount is greater than 200