searchResources( )


Retrieves a list of resources matching the provided search criteria.

Refer to the supported filters article (SDK | REST) for complete filter and sorting options.

PropertyCapabilitiesFilters
singleResource.locationOptions.specificLocationOptions.businessLocations.locationIdSearch: ✗
Aggregate: ✓
Sort: ASC, DESC
$hasAll, $hasSome
_createdDateSearch: ✗
Aggregate: ✓
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte
_idSearch: ✗
Aggregate: ✓
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
_updatedDateSearch: ✗
Aggregate: ✓
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte
appIdSearch: ✗
Aggregate: ✓
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
managementTypeSearch: ✗
Aggregate: ✓
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any
nameSearch: ✗
Aggregate: ✗
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
singleResource.locationOptions.availableInAllLocationsSearch: ✗
Aggregate: ✓
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any
singleResource.locationOptions.specificLocationOptions.availableInBusinessLocationsSearch: ✗
Aggregate: ✓
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any
singleResource.locationOptions.specificLocationOptions.availableInCustomLocationsSearch: ✗
Aggregate: ✓
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any
singleResource.locationOptions.specificLocationOptions.availableInCustomerLocationsSearch: ✗
Aggregate: ✓
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any
typeSearch: ✗
Aggregate: ✓
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
Permissions
Manage Bookings - all permissions
Read Bookings - all read permissions
Manage Bookings
Read Bookings - Public Data
Read Bookings - Including Participants
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
searchCursorSearchRequired

Search criteria including filter, sort, aggregations, and paging options.

Refer to the supported filters article (SDK | REST) for complete filter and sorting options.

Returns
Return Type:Promise<SearchResourcesResponse>
Errors

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

Did this help?