Resources: Filtering and Sorting

Query endpoints allow you to filter and sort results based on resource properties. This article covers field support for filtering and sorting.

Filtering

Specify the filter object in the following format:

Copy

The following table shows field support for filters and sorting for the Resource object:

Field	Supported Filters	Sortable
`id`	`$eq`, `$ne`, `$exists`, `$in`, `$nin`, `$startsWith`	Sortable
`name`	`$eq`, `$ne`, `$exists`, `$in`, `$nin`, `$isEmpty`
`typeId`	`$eq`, `$ne`, `$exists`, `$in`, `$nin`, `$startsWith`, `$isEmpty`	Sortable
`locationOptions.availableInAllLocations`	`$eq`, `$ne`, `$exists`, `$in`, `$nin`	Sortable
`locationOptions.specificLocationOptions.availableInBusinessLocations`	`$eq`, `$ne`, `$exists`, `$in`, `$nin`	Sortable
`locationOptions.specificLocationOptions.businessLocations.locationId`	`$eq`, `$ne`, `$isEmpty`, `$hasAll`, `$hasSome`	Sortable
`eventsSchedule.scheduleId`	`$eq`, `$ne`, `$exists`, `$in`, `$nin`, `$startsWith`	Sortable

Results are sorted by the id field in ascending order by default.

To sort by a different field, use the sort object in the following format:

Copy

Related content:

Did this help?