POST

Query Staff Members

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 staff members, given the provided paging, filtering, and sorting.

Defaults

Query Staff Members has the following default settings, which you can override:

  • Sorted by createdDate in ascending order.
  • cursorPaging.limit set to 100.

Filter

Refer to the supported filters article (REST) for a complete list of supported filters and sorting options.

See also

To learn about working with Query methods, see API Query Language and Sorting and Paging.

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/v1/staff-members/query
Body Params
queryQuery

Information about filters, paging, and sorting. See the article about booking policy filters (REST) for all supported filters and sorting options.

fieldsArray <string>maxItems 3

Conditional fields to return.

Response Object
staffMembersArray <StaffMember>

Retrieved staff members.

pagingMetadataPagingMetadata

Paging metadata.

Query staff members, providing fields parameter to request additional fields.

Request
cURL
curl -X POST \
'https://www.wixapis.com/bookings/v1/staff-members/query' \
-H 'Authorization: <AUTH>' \
-d '{
  "query": {
    "cursorPaging": {
      "cursor": null,
      "limit": 100
    },
    "fields": ["RESOURCE_DETAILS"]
  }
}'
Response
JSON
{
  "staffMembers": [{
     "id": "0954bbb2-88cd-445c-9827-44253eb8b039",
     "name": "Some other name",
     "resourceId": "e0936563-7fd8-4e08-9db0-a327b2cb653e",
     "default": false,
     "revision": "3",
     "createdDate": "2024-08-28T13:22:32.784Z",
     "updatedDate": "2024-08-28T14:16:11.948Z",
     "resource": {
        "id": "e0936563-7fd8-4e08-9db0-a327b2cb653e",
         "working_hours_schedules": [
           {
             "id": "77ee564a-80d5-4ffc-85a3-284df66a0d12",
             "shared": true
           }
         ],
         "events_schedule": {
           "id": "7c147d9e-89a8-4e2e-a723-b095db0610c1"
         },
         "uses_default_working_hours": true
     }
  }]
  "pagingMetadata": {
    "count": 1,
    "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?