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 staff members matching the provided search criteria.
Use WQL to define the search criteria.
The search endpoints allow to perform advance search including partial text search, exact match, and more. The endpoint also allows to aggregate staff members by their name, email, phone, description, or resource id.
WQL expression.
Conditional fields to return.
The retrieved staff members matching the search criteria.
Paging metadata. Including paging, offset and cursor.
Aggregation data results, resulting from the aggregations stated in the request.
Search staff members, matching staff members based on a search term to match the last name.
curl -X POST \
'https://www.wixapis.com/bookings/v1/staff-members/query' \
-H 'Authorization: <AUTH>' \
-d '{
"search": {
"search": {
"fields": [
"name"
],
"expression": "Lastname"
},
"cursor_paging": {
"limit": 100
}
}
}'
{
"staff_members": [
{
"id": "21954d5c-6345-4b62-8526-6a86b2a5a734",
"name": "Some Lastname",
"email": null,
"phone": null,
"description": null,
"main_media": null,
"resource_id": "e0936563-7fd8-4e08-9db0-a327b2cb653e",
"resource": null,
"associated_wix_identity": null,
"associated_conferencing_providers": null,
"default": false,
"revision": "3",
"created_date": "2024-08-28T14:45:02.858Z",
"updated_date": "2024-08-28T14:51:06.975Z",
"extended_fields": null,
"associated_conferencing_accounts": null
}
],
"paging_metadata": {
"count": 1,
"cursors": {
"next": null,
"prev": null
},
"has_next": false
},
"aggregation_data": null
}
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.