Filtering and Sorting

Filtering

By default, all Lists resources can be filtered by any fields in object As long as we do not specify else in API request reference.

For Filtering data add filter parameter as array, eg. for filter users by restricted:

you can filter by many fields:

You can specify multiple matching filter values by passing a comma separated list of values:

the response will contain all users that contain "seb" OR "freek" in their name

Operator filters

You can also use dynamic operator filters, which allow you to specify the operator in the filter value

the response will contain all users with a salary greater than 3000.

this all Operators can use:

EQUAL: =

LESS THAN: <

GREATER THAN: >

LESS THAN OR EQUAL: <=

GREATER THAN OR EQUAL: >=

NOT EQUAL: <>

Date filters

You can also filter by date in fields end by _at:

You can also use dynamic operator filters:

You can also use between filter:

Sorting

The sort query parameter is used to determine by which property the results collection will be ordered. Sorting is ascending by default and can be reversed by adding a hyphen (-) to the start of the property name.
By defualt you can sort by any fields in object As long as we do not specify else in API request reference.
Eg.

the response will be sorted by name and descending (Z -> A)

You can sort by multiple properties by separating them with a comma:

the response will be sorted by name in ascending order with a secondary sort on street in descending order.

Filtering and Sorting

Filtering#

Operator filters#

Date filters#

Sorting#

Filtering

Operator filters

Date filters

Sorting