POST

Query Services

Note: This query method uses the new Wix API Query Language syntax. If you're still using the old query syntax with chained query builder methods, see Migrate from SDK Query Builders to Wix API Query Language for guidance. The old query builder methods continue to work.

Retrieves a list of up to 100 services, given the provided paging, filtering, and sorting.

Defaults

Query 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.

Conditional fields

Use the conditionalFields request parameter to receive additional data in the response. These fields are excluded from the response by default because retrieving them requires additional calls to other services.

Supported values:

  • STAFF_MEMBER_DETAILS: Returns service.staffMemberDetails.
  • RESOURCE_TYPE_DETAILS: Returns the name of each service resource's resource type. See service.serviceResources.resourceType.name.
  • DISCOUNT_INFO_DETAILS: Returns service.payment.discountInfo.
  • RESOURCE_DETAILS: Returns the name of each individual resource assigned to a service resource. See service.serviceResources.resourceDetails.

See also

To learn about working with Query methods, see API Query Language and Sorting and Paging.

PropertyFiltersSort
_id$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
appId$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
name$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
type$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
description$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
hidden$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
tagLine$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
staffMemberIds$eq, $ne, $exists, $in, $hasSome, $hasAllSort: ASC, DESC
form._id$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
category._id$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
category.name$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
locations.business._id$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
mainSlug.name$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
supportedSlugs.name$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
onlineBooking.enabled$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
payment.options.online$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
payment.options.inPerson$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
payment.options.pricingPlan$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
schedule.firstSessionStart$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
schedule.lastSessionEnd$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
Permissions
Wix Multilingual - Nile Wrapper Domain Events Read
Learn more about app permissions.
Method Declaration
Copy
Errors

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

Did this help?