Filtering

Advanced Filtering

Learn how to refine your API requests using flexible filtering options. You can apply filters by value, range, status, and more.

Use a simple filter to retrieve records that match a single condition (e.g., unpaid invoices).

Apply more than one filter in a single request to narrow down results based on multiple criteria.

Filter results within a specific date range using gte (greater than or equal) and lte (less than or equal) operators.

OR logic without indexes when you don't need grouping. Use filter[or] without numeric indexes.

Operator	Description	Example
`eq`	Equals (default)	`filter[payment_status]=0`
`not_equal`	Not equals	`filter[payment_status][not_equal]=0`
`gt`	Greater than	`filter[summary_total][gt]=1000`
`gte`	Greater than or equal	`filter[summary_total][gte]=1000`
`lt`	Less than	`filter[summary_total][lt]=5000`
`lte`	Less than or equal	`filter[summary_total][lte]=5000`
`from`	From value (alias for gte)	`filter[date][from]=2024-01-01`
`to`	To value (alias for lte)	`filter[date][to]=2024-12-31`
`like`	Contains (text search)	`filter[business_name][like]=john`
`in`	In (array)	`filter[payment_status][in][]=0&filter[payment_status][in][]=1`
`not_in`	Not in (array)	`filter[available_online][not_in][]=1`
`is_null`	Is null	`filter[deleted_at][is_null]=1`

Filter for invoices that are unpaid and have a total between 1000 and 5000:

Filter for multiple payment statuses:

Find customers with names containing "john":

Find records where a field is null:

Find items matching any of multiple tracking codes: