queryServices( )
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 paging, filtering, and sorting.
queryServices() runs with these defaults, which you can override:
paging.limitis100.paging.offsetis0.
Notes:
- Use UTC format when filtering with dates.
- Only 1 use of each filter in the same query is supported. If a filter is defined more than once in a query, only the first occurrence is processed.
| PROPERTY | SUPPORTED FILTERS & SORTING |
|---|---|
type | eq(),ne(),exists(),in(),hasSome() |
name | eq(),ne(),exists(),in(),hasSome(),startsWith() |
description | eq(),ne(),exists(),in(),hasSome(),startsWith() |
tagLine | eq(),ne(),exists(),in(),hasSome(),startsWith() |
hidden | eq(),ne(),exists(),in(),hasSome() |
category.id | eq(),ne(),exists(),in(),hasSome(),startsWith() |
category.name | eq(),ne(),exists(),in(),hasSome(),startsWith() |
form.id | eq(),ne(),exists(),in(),hasSome(),startsWith() |
payment.options.online | eq(),ne(),exists(),in(),hasSome() |
payment.options.inPerson | eq(),ne(),exists(),in(),hasSome() |
payment.options.pricingPlan | eq(),ne(),exists(),in(),hasSome() |
onlineBooking.enabled | eq(),ne(),exists(),in(),hasSome() |
locations.business.id | eq(),ne(),exists(),in(),hasSome(),startsWith() |
staffMemberIds | eq(),ne(),exists(),in(),hasSome(),hasAll() |
supportedSlugs.name | eq(),ne(),exists(),in(),hasSome(),startsWith() |
mainSlug.name | eq(),ne(),exists(),in(),hasSome(),startsWith() |
Permission Scopes
For app development, you must have one of the following permission scopes:Read Bookings - Public Data
Manage Bookings Services and Settings
Manage Bookings
Read Bookings - Including Participants
Read Bookings - all read permissions
Manage Bookings - all permissions
Learn more about permission scopes.
Method Declaration
Copy
Request
This method does not take any parameters
Was this helpful?
Yes
No