Staff Members: Filtering and Sorting

This article covers field support for filtering in:

  • Query Staff Members (SDK | REST).
  • Search Staff Members (REST).
  • Count Staff Members (SDK | REST).
  • Bulk Update Staff Member Tags By Filter (SDK | REST).

Filtering

Specify the filter object in the following format:

Copy

The following table shows field support for filters and sorting for the staffMember object:

FieldSupported FiltersSortable
id$eq, $ne, $exists, $in, $nin, $startsWithSortable
description$eq, $ne, $exists, $in, $nin, $startsWithSortable
name$eq, $ne, $exists, $in, $nin
email$eq, $ne, $exists, $in, $nin
phone$eq, $ne, $exists, $in, $nin
default$eq, $ne, $exists, $in, $nin
associatedWixIdentity.identificationData.contactId$eq, $ne, $exists, $in, $nin, $startsWithSortable
associatedWixIdentity.identificationData.wixUserId$eq, $ne, $exists, $in, $nin, $startsWithSortable
associatedWixIdentity.identificationData.identityType$eq, $ne, $exists, $in, $nin, $startsWithSortable
resource.locationOptions.specificLocationOptions.businessLocations.locationId$hasSome, $hasAll, $isEmpty

Sorting

Results in Query Staff Members (SDK | REST), and Search Staff Members (REST) are sorted by the id field in ascending order by default.

To sort by a different field, use the sort object in the following format:

Copy

See also

Did this help?