Post

Query Service Catalog

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Deprecation Notice

This endpoint has been replaced with Services V2's Query Services and will be removed on December 31, 2023. If your app uses this endpoint, we recommend updating your code as soon as possible.

Returns a list of services and related information according to the specified query.

Related information includes:

Pricing plans
Resources
Forms
Schedules
Categories
URLs
Slugs

The query runs with the following defaults:

Copy

The following fields and filters are supported in the query:

FIELD	Supported filters
`service.id`	`$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
`service.info.name`	`$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
`service.info.tagLine`	`$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
`service.policy.isBookOnlineAllowed`	`$eq`, `$ne`
`service.customProperties.tag`	`$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
`service.paymentOptions.wixPayOnline`	`$eq`, `$ne`
`service.paymentOptions.wixPayInPerson`	`$eq`, `$ne`
`service.paymentOptions.wixPaidPlan`	`$eq`, `$ne`
`service.paymentOptions.custom`	`$eq`, `$ne`
`service.policy.bookingsApprovalPolicy. isBusinessApprovalRequired`	`$eq`, `$ne`
`service.schedules.availability. locations.businessLocation.ids`	`$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
`category.id`	`$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
`category.name`	`$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
`slugs.name`	`$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
`schedules.tags`	`$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
`resources.id`	`$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
paging	Supported.
fields	Supported.
fieldsets	Not supported.

Notes:

The following objects in the query parameter are not supported for this query:
- sort
- fieldsets
The businessLocation.businessSchedule object in the location object is not supported.

Permissions This endpoint requires the Read Bookings - Public Data, the Read Bookings - Including Participants or the Manage Bookings permissions scope

Endpoint

POST

https://www.wixapis.com/bookings/v1/catalog/services/query

Was this helpful?

Yes