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 contacts using a free-text search combined with filtering and sorting.
Search combines free-text matching with filtering, sorting, and cursor paging. To learn about the query syntax, see API Query Language.
Searchable properties: name.full, email.email, phone.phone, company.name, company.jobTitle, memberInfo.email, and memberInfo.profileInfo.nickname.
Name format: Set nameFormat to control how names are matched and ordered:
BY_FIRST_NAME: Orders by first name, then last name.BY_LAST_NAME: Orders by last name, then first name.| Property | Capabilities | Filters |
|---|---|---|
assigneeId | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $exists, $in, $ne, $nin |
memberInfo.memberId | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $exists, $in, $ne, $nin |
source.appId | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $exists, $in, $ne, $nin |
source.userId | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $exists, $in, $ne, $nin |
timeZone | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $exists, $in, $ne, $nin |
memberInfo.profileInfo.privacyStatus | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $exists, $in, $ne, $nin |
memberInfo.status | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $exists, $in, $ne, $nin |
memberInfo.userInfo.role | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $exists, $in, $ne, $nin |
memberInfo.emailVerificationRequired | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne |
memberInfo.emailVerified | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne |
memberInfo.profileInfo.muted | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne |
memberInfo.profileInfo.reported | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne |
createdDate | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $gt, $gte, $lt, $lte, $ne |
updatedDate | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $gt, $gte, $lt, $lte, $ne |
lastActivity.date | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $gt, $gte, $lt, $lte, $ne |
memberInfo.sessionInfo.lastMobileLogin | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $gt, $gte, $lt, $lte, $ne |
memberInfo.sessionInfo.lastWebLogin | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $gt, $gte, $lt, $lte, $ne |
memberInfo.signupDate | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $gt, $gte, $lt, $lte, $ne |
company.jobTitle | Search: ✓ Aggregate: ✗ Sort: ASC, DESC | $eq, $exists, $in, $ne, $nin, $startsWith |
company.name | Search: ✓ Aggregate: ✗ Sort: ASC, DESC | $eq, $exists, $in, $ne, $nin, $startsWith |
email.email | Search: ✓ Aggregate: ✗ Sort: ASC, DESC | $eq, $exists, $in, $ne, $nin, $startsWith |
memberInfo.email | Search: ✓ Aggregate: ✗ Sort: ASC, DESC | $eq, $exists, $in, $ne, $nin, $startsWith |
memberInfo.profileInfo.nickname | Search: ✓ Aggregate: ✗ Sort: ASC, DESC | $eq, $exists, $in, $ne, $nin, $startsWith |
name.first | Search: ✗ Aggregate: ✗ Sort: ASC, DESC | $eq, $exists, $in, $ne, $nin, $startsWith |
name.last | Search: ✗ Aggregate: ✗ Sort: ASC, DESC | $eq, $exists, $in, $ne, $nin, $startsWith |
phone.phone | Search: ✓ Aggregate: ✗ Sort: ASC, DESC | $eq, $exists, $in, $ne, $nin, $startsWith |
id | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $in, $ne, $nin |
email.deliverabilityStatus | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $in, $ne, $nin |
email.subscriptionStatus.status | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $in, $ne, $nin |
phone.deliverabilityStatus | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $in, $ne, $nin |
phone.subscriptionStatus.status | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $in, $ne, $nin |
locale | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $exists, $in, $ne, $nin, $startsWith |
phone.e164 | Search: ✗ Aggregate: ✗ Sort: ✗ | $eq, $exists, $in, $ne, $nin, $startsWith |
source.additionalInfo | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $exists, $in, $ne, $nin, $startsWith |
locationIds | Search: ✗ Aggregate: ✓ Sort: ✗ | $exists, $hasAll, $hasSome, $isEmpty |
memberInfo.groupInfo.groupIds | Search: ✗ Aggregate: ✓ Sort: ✗ | $exists, $hasAll, $hasSome, $isEmpty |
memberInfo.sessionInfo.mobileAppNames | Search: ✗ Aggregate: ✓ Sort: ✗ | $exists, $hasAll, $hasSome, $isEmpty |
segmentIds | Search: ✗ Aggregate: ✓ Sort: ✗ | $exists, $hasAll, $hasSome, $isEmpty |
tags.privateTags.tagIds | Search: ✗ Aggregate: ✓ Sort: ✗ | $exists, $hasAll, $hasSome, $isEmpty |
addresses.address.country | Search: ✗ Aggregate: ✓ Sort: ✗ | $exists, $hasAll, $hasSome |
addresses.address.subdivision | Search: ✗ Aggregate: ✓ Sort: ✗ | $exists, $hasAll, $hasSome |
addresses.recipient.phone | Search: ✗ Aggregate: ✗ Sort: ✗ | $exists, $hasAll, $hasSome |
additionalEmails.email | Search: ✗ Aggregate: ✗ Sort: ✗ | $exists, $hasAll, $hasSome, $startsWith |
additionalPhones.e164 | Search: ✗ Aggregate: ✗ Sort: ✗ | $exists, $hasAll, $hasSome, $startsWith |
additionalPhones.phone | Search: ✗ Aggregate: ✗ Sort: ✗ | $exists, $hasAll, $hasSome, $startsWith |
addresses.address.addressLine | Search: ✗ Aggregate: ✗ Sort: ✗ | $exists, $hasAll, $hasSome, $startsWith |
addresses.address.city | Search: ✗ Aggregate: ✗ Sort: ✗ | $exists, $hasAll, $hasSome, $startsWith |
addresses.address.postalCode | Search: ✗ Aggregate: ✗ Sort: ✗ | $exists, $hasAll, $hasSome, $startsWith |
addresses.address.streetAddress.name | Search: ✗ Aggregate: ✗ Sort: ✗ | $exists, $hasAll, $hasSome, $startsWith |
addresses.address.subdivisionFullname | Search: ✗ Aggregate: ✓ Sort: ✗ | $exists, $hasAll, $hasSome, $startsWith |
addresses.recipient.company | Search: ✗ Aggregate: ✗ Sort: ✗ | $exists, $hasAll, $hasSome, $startsWith |
addresses.recipient.firstName | Search: ✗ Aggregate: ✗ Sort: ✗ | $exists, $hasAll, $hasSome, $startsWith |
addresses.recipient.lastName | Search: ✗ Aggregate: ✗ Sort: ✗ | $exists, $hasAll, $hasSome, $startsWith |
birthdate | Search: ✗ Aggregate: ✗ Sort: ASC, DESC | $eq, $gt, $gte, $lt, $lte, $ne |
name.full | Search: ✓ Aggregate: ✗ Sort: ✗ |
You can only call this method when authenticated as a Wix app or Wix user identity.
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.