POST

Search Services

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.

Property	Capabilities	Filters
`addOnDetails.addOnId`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$hasAll`, `$hasSome`
`addOnDetails.durationInMinutes`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$hasAll`, `$hasSome`
`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`
`serviceResources.resourceIds.values`	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`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`appId`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`category.id`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`category.name`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`category.sortOrder`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`
`description`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`form.id`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`hidden`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`
`mainSlug.name`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`name`	Search: ✓ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`onlineBooking.enabled`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`
`payment.options.inPerson`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`
`payment.options.online`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`
`payment.options.pricingPlan`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`
`tagLine`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`type`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`

Permissions

Learn more about app permissions.

Endpoint

POST

https://www.wixapis.com/_api/bookings/v2/services/search

Errors

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

Did this help?

Search Services

Defaults

Filters

See also