Services: Filtering and Sorting

Query endpoints allow you to filter and sort results based on service 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 service object:

Field	Supported Filters	Sortable
`name`	`$eq`, `$ne`, `$exists`, `$in`, `$startsWith`	Sortable
`type`	`$eq`, `$ne`, `$exists`, `$in`,	Sortable
`description`	`$eq`, `$ne`, `$exists`, `$in`, `$startsWith`	Sortable
`hidden`	`$eq`, `$ne`, `$exists`, `$in`
`tagLine`	`$eq`, `$ne`, `$exists`, `$in`, `$startsWith`	Sortable
`staffMemberIds`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`
`form.id`	`$eq`, `$ne`, `$exists`, `$in`, `$startsWith`
`category.id`	`$eq`, `$ne`, `$exists`, `$in`, `$startsWith`
`mainSlug.name`	`$eq`, `$ne`, `$exists`, `$in`, `$startsWith`	Sortable
`supportedSlugs.name`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`	Sortable
`locations.business.id`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`
`onlineBooking.enabled`	`$eq`, `$ne`, `$exists`, `$in`
`payment.options.online`	`$eq`, `$ne`, `$exists`, `$in`
`payment.options.inPerson`	`$eq`, `$ne`, `$exists`, `$in`
`payment.options.pricingPlan`	`$eq`, `$ne`, `$exists`, `$in`

The default sort is by createdDate in ascending (ASC) order.

Specify the sort object in the following format:

Copy

Specify the fields object in the following format:

Copy

Related content:

Was this helpful?

Yes