Services: Filtering and Sorting

This article covers field support for filtering in Query Services (SDK | REST) and Search Services (SDK | REST).

Filtering

Specify the filter object in the following format:

Copy

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

FieldSupported FiltersSortable
name$eq, $ne, $exists, $in, $startsWithSortable
type$eq, $ne, $exists, $in,Sortable
description$eq, $ne, $exists, $in, $startsWithSortable
hidden$eq, $ne, $exists, $in
tagLine$eq, $ne, $exists, $in, $startsWithSortable
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, $startsWithSortable
supportedSlugs.name$eq, $ne, $exists, $in, $hasSome, $startsWithSortable
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
schedule.firstSessionStart$eq, $ne, $exists, $inSortable
schedule.lastSessionEnd$eq, $ne, $exists, $inSortable

Sorting

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

Specify the sort object in the following format:

Copy

Fields

Specify the fields object in the following format:

Copy

See also

Did this help?