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: ASC, DESC | $hasAll, $hasSome |
locations.business.name | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $hasAll, $hasSome |
locations.calculatedAddress.formattedAddress | Search: ✗ Aggregate: ✗ Sort: ASC, DESC | $hasAll, $hasSome |
locations.type | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $hasAll, $hasSome |
staffMemberIds | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $hasAll, $hasSome |
supportedSlugs.name | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $hasAll, $hasSome |
id | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
addOnDetails.addOnId | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
addOnDetails.durationInMinutes | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte |
category.id | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
category.name | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
category.sortOrder | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte |
description | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
form.id | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
hidden | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any |
mainSlug.name | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
name | Search: ✓ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
onlineBooking.enabled | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any |
payment.options.inPerson | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any |
payment.options.online | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any |
payment.options.pricingPlan | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any |
tagLine | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
type | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any |
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.