POST

Query Resources

Deprecated

This method has been replaced with Query Resources, and will be removed on June 30, 2025.

Retrieves a list of the resources according to the specified filters and paging.

The query parameter is optional. If no query is provided then all non-deleted resources are returned. Resources that are in a resource group (i.e. the group_id property contains an ID) are excluded from the result for backwards compatibility unless the include_resources_with_groups request field is set to true.

PropertyIs supported
filtersupported fields: resource.id, resource.tags, resource.status
pagingsupported
fieldssupported
fieldsetsnot supported
sortnot supported

Notes:

  • The following objects in the query parameter are not supported for this query:
    • sort
    • fieldsets

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

Permissions
Manage Bookings Services and Settings
Manage Bookings - all permissions
Read Bookings - all read permissions
Manage Bookings
Read Bookings - Public Data
Read Bookings - Including Participants
Read bookings calendar - including participants
Read Bookings Calendar
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/bookings/v1/resources/query
Body Params
queryQuery
Response Object
resourcesArray <Resource>

List of resources matching the query object.

pagingMetadataPagingMetadata
Query Resource

Return a list of resources with a "staff" tag and a status of "UPDATED" or "DELETED".

Request
cURL
curl -L -X POST 'https://www.wixapis.com/bookings/v1/resources/query' \
-H 'Authorization: <AUTH>' \
-H 'Content-Type: application/json' \
--data-raw '{
  "query": {
      "filter":{"resource.tags":{"$in":"staff"},
                "resource.status":{"$in":["DELETED","UPDATED"]}        
      },
      "fields":["name","tags", "status"],
      "paging" :{"limit" : 10, "offset" : 3}
    }
}'
Response
JSON
{
  "resources": [
    {
      "name": "John Doe",
      "tags": ["staff"],
      "images": [],
      "schedules": [],
      "scheduleIds": [],
      "status": "DELETED"
    },
    {
      "name": "Frank Walker",
      "tags": ["staff"],
      "images": [],
      "schedules": [],
      "scheduleIds": [],
      "status": "DELETED"
    },
    {
      "name": "Francine Williams",
      "tags": ["staff"],
      "images": [],
      "schedules": [],
      "scheduleIds": [],
      "status": "DELETED"
    },
    {
      "name": "Jack Black",
      "tags": ["staff"],
      "images": [],
      "schedules": [],
      "scheduleIds": [],
      "status": "UPDATED"
    },
    {
      "name": "Bonita Juan",
      "tags": ["staff"],
      "images": [],
      "schedules": [],
      "scheduleIds": [],
      "status": "DELETED"
    },
    {
      "name": "Sven Jorgensen",
      "tags": ["staff"],
      "images": [],
      "schedules": [],
      "scheduleIds": [],
      "status": "DELETED"
    },
    {
      "name": "Michael McDonald",
      "tags": ["staff"],
      "images": [],
      "schedules": [],
      "scheduleIds": [],
      "status": "DELETED"
    },
    {
      "name": "Lisa Lopez",
      "tags": ["staff"],
      "images": [],
      "schedules": [],
      "scheduleIds": [],
      "status": "DELETED"
    },
    {
      "name": "Sofia Carlton",
      "tags": ["staff"],
      "images": [],
      "schedules": [],
      "scheduleIds": [],
      "status": "DELETED"
    },
    {
      "name": "Paul St. John",
      "tags": ["staff"],
      "images": [],
      "schedules": [],
      "scheduleIds": [],
      "status": "DELETED"
    }
  ],
  "pagingMetadata": {
    "count": 10,
    "offset": 3,
    "total": 178
  }
}
Errors

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

Did this help?