searchServices( )


Developer Preview

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.

Defaults

Search Services has the following default settings, which you can override:

  • Sorted by createdDate in ascending order.
  • paging.limit set to 100.
  • paging.offset set to 0.

Filters

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.

See also

To learn about working with Search methods, see API Query Language (SDK | REST) and Sorting and Paging (SDK | REST).

PropertyCapabilitiesFilters
locations.business._idSearch: ✗
Aggregate:
Sort: ✗
$hasAll, $hasSome
locations.business.nameSearch: ✗
Aggregate:
Sort: ✗
$hasAll, $hasSome
locations.calculatedAddress.formattedAddressSearch: ✗
Aggregate: ✗
Sort: ✗
$hasAll, $hasSome
locations.typeSearch: ✗
Aggregate:
Sort: ✗
$hasAll, $hasSome
staffMemberIdsSearch: ✗
Aggregate:
Sort: ✗
$hasAll, $hasSome
supportedSlugs.nameSearch: ✗
Aggregate:
Sort: ✗
$hasAll, $hasSome
_idSearch: ✗
Aggregate:
Sort: ✗
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
addOnDetails.addOnIdSearch: ✗
Aggregate:
Sort: ✗
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
addOnDetails.durationInMinutesSearch: ✗
Aggregate:
Sort: ✗
$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte
appIdSearch: ✗
Aggregate:
Sort: ✗
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
category._idSearch: ✗
Aggregate:
Sort: ✗
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
category.nameSearch: ✗
Aggregate:
Sort: ✗
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
category.sortOrderSearch: ✗
Aggregate:
Sort: ✗
$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte
descriptionSearch: ✗
Aggregate:
Sort: ✗
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
form._idSearch: ✗
Aggregate:
Sort: ✗
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
hiddenSearch: ✗
Aggregate:
Sort: ✗
$eq, $ne, $exists, $in, $any
mainSlug.nameSearch: ✗
Aggregate:
Sort: ✗
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
nameSearch: ✗
Aggregate:
Sort: ✗
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
onlineBooking.enabledSearch: ✗
Aggregate:
Sort: ✗
$eq, $ne, $exists, $in, $any
payment.options.inPersonSearch: ✗
Aggregate:
Sort: ✗
$eq, $ne, $exists, $in, $any
payment.options.onlineSearch: ✗
Aggregate:
Sort: ✗
$eq, $ne, $exists, $in, $any
payment.options.pricingPlanSearch: ✗
Aggregate:
Sort: ✗
$eq, $ne, $exists, $in, $any
tagLineSearch: ✗
Aggregate:
Sort: ✗
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
typeSearch: ✗
Aggregate:
Sort: ✗
$eq, $ne, $exists, $in, $any
Permissions
Manage Bookings Services and Settings
Manage Bookings - all permissions
Read Bookings - all read permissions
Manage Bookings
Read Bookings - Public Data
Read Bookings - Including Participants
Manage Stores
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
searchCursorSearchRequired

WQL, search or aggregation expression.

Returns
Return Type:Promise<SearchServicesResponse>
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?