POST

Query Resources


Developer Preview

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

Query resources using WQL - Wix Query Language.

For field support for filters and sorting, see Resources: Filtering and Sorting.

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.
Endpoint
POST
https://www.wixapis.com/bookings/v2/resources/query

Body Params
queryQuery

WQL expression.

Response Object
resourcesArray <Resource>

The retrieved Resources.


pagingMetadataPagingMetadata

Paging metadata

Query resources, filtering by resource type and providing a limit to the number of results returned.

Request
cURL
curl -X POST \ 'https://www.wixapis.com/bookings/v2/resources/query' \ -H 'Authorization: <AUTH>' \ -d '{ "query": { "filter": { "type": { "$eq": "dd7790c7-f3ac-4821-accb-52ed385fd932" } }, "cursorPaging": { "cursor": null, "limit": 100 } } }'
Response
JSON
{ "resources": [ { "id": "ef5f8d3d-9269-490c-a067-a3d226fcb5d8", "revision": "1", "createdDate": "2024-11-22T14:02:34.993Z", "updatedDate": "2024-11-22T14:02:34.993Z", "name": "Small meeting room", "typeId": "dd7790c7-f3ac-4821-accb-52ed385fd932", "locationOptions": { "availableInAllLocations": false, "specificLocationOptions": { "availableInBusinessLocations": true, "businessLocations": [ { "locationId": "808dfb00-0a74-4e70-bb3b-f96ff6ba1246" } ] } }, "eventsSchedule": { "scheduleId": "ee500718-7ce3-478a-89fb-1d839a37e324" } }, { "resource": { "id": "ffedf9dc-932d-439f-b1f4-e42b2a5a8bb5", "revision": "1", "createdDate": "2024-11-22T13:36:47.104Z", "updatedDate": "2024-11-22T13:36:47.104Z", "name": "Meeting room with conference system", "typeId": "dd7790c7-f3ac-4821-accb-52ed385fd932", "locationOptions": { "availableInAllLocations": false, "specificLocationOptions": { "availableInBusinessLocations": true, "businessLocations": [ { "locationId": "1295e5ff-ecb3-41bc-8b6f-7345792e5ec0" } ] } }, "eventsSchedule": { "scheduleId": "e263b1ca-a1e9-45bf-a39c-044e97c63500" } } } ], "pagingMetadata": { "count": 2, "cursors": {}, "hasNext": false } }
Errors

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

Did this help?