This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a list of up to 100 services, given the provided filtering, paging, and sorting.
Search Services has the following default settings, which you can override:
createdDate
in ascending order.paging.limit
set to 100
.paging.offset
set to 0
.When using filters for dates, you must use UTC time.
Refer to the supported filters article (REST) for a complete list of supported filters and sorting options.
To learn about working with Search methods, see API Query Language (SDK | REST) and Sorting and Paging (SDK | REST).
Property | Capabilities | Filters |
---|---|---|
locations.business._id | Search: ✗ Aggregate: ✓ Sort: ✗ | $hasAll , $hasSome |
locations.business.name | Search: ✗ Aggregate: ✓ Sort: ✗ | $hasAll , $hasSome |
locations.calculatedAddress.formattedAddress | Search: ✗ Aggregate: ✗ Sort: ✗ | $hasAll , $hasSome |
locations.type | Search: ✗ Aggregate: ✓ Sort: ✗ | $hasAll , $hasSome |
staffMemberIds | Search: ✗ Aggregate: ✓ Sort: ✗ | $hasAll , $hasSome |
supportedSlugs.name | Search: ✗ Aggregate: ✓ Sort: ✗ | $hasAll , $hasSome |
_id | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq , $ne , $exists , $in , $any , $begins , $gt , $lt , $lte , $gte |
addOnDetails.addOnId | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq , $ne , $exists , $in , $any , $begins , $gt , $lt , $lte , $gte |
addOnDetails.durationInMinutes | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq , $ne , $exists , $in , $any , $lt , $lte , $gt , $gte |
appId | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq , $ne , $exists , $in , $any , $begins , $gt , $lt , $lte , $gte |
category._id | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq , $ne , $exists , $in , $any , $begins , $gt , $lt , $lte , $gte |
category.name | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq , $ne , $exists , $in , $any , $begins , $gt , $lt , $lte , $gte |
category.sortOrder | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq , $ne , $exists , $in , $any , $lt , $lte , $gt , $gte |
description | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq , $ne , $exists , $in , $any , $begins , $gt , $lt , $lte , $gte |
form._id | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq , $ne , $exists , $in , $any , $begins , $gt , $lt , $lte , $gte |
hidden | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq , $ne , $exists , $in , $any |
mainSlug.name | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq , $ne , $exists , $in , $any , $begins , $gt , $lt , $lte , $gte |
name | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq , $ne , $exists , $in , $any , $begins , $gt , $lt , $lte , $gte |
onlineBooking.enabled | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq , $ne , $exists , $in , $any |
payment.options.inPerson | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq , $ne , $exists , $in , $any |
payment.options.online | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq , $ne , $exists , $in , $any |
payment.options.pricingPlan | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq , $ne , $exists , $in , $any |
tagLine | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq , $ne , $exists , $in , $any , $begins , $gt , $lt , $lte , $gte |
type | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq , $ne , $exists , $in , $any |
WQL, search or aggregation expression.
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.