Retrieves a list of contacts, given the provided paging, filtering, and sorting.
Up to 1,000 contacts can be returned per request. Query Contacts runs with these defaults, which you can override:
createdDate is sorted in ASC orderpaging.limit is 50paging.offset is 0For field support for filters and sorting, see Contacts: Supported Filters and Sorting.
To learn about working with Query methods, see API Query Language, Sorting and Paging, and Field Projection.
| Field | Supported Filters | Sort |
|---|---|---|
id | $eq, $ne, $in, $exists | Sort: ✗ |
info.locale | $eq, $ne, $in, $exists | Sort: ✗ |
createdDate | $eq, $ne, $gt, $lt, $gte, $lte | Sort: ASC, DESC |
lastActivity.activityDate | $eq, $ne, $gt, $lt, $gte, $lte | Sort: ASC, DESC |
info.birthdate | $eq, $ne, $gt, $lt, $gte, $lte | Sort: ASC, DESC |
updatedDate | $eq, $ne, $gt, $lt, $gte, $lte | Sort: ✗ |
primaryInfo.email | $eq, $ne, $in, $exists, $begins | Sort: ASC, DESC |
info.name.first | $eq, $ne, $in, $exists, $begins | Sort: ASC, DESC |
info.name.last | $eq, $ne, $in, $exists, $begins | Sort: ASC, DESC |
info.company | $eq, $ne, $in, $exists, $begins | Sort: ASC, DESC |
info.jobTitle | $eq, $ne, $in, $exists, $begins | Sort: ASC, DESC |
primaryInfo.phone | $eq, $ne, $in, $exists, $begins | Sort: ✗ |
info.labelKeys | $hasSome, $hasAll | Sort: ✗ |
You can only call this method when authenticated as a Wix app or Wix user identity.
There are 8 errors with this status code.
This method may also return standard errors. Learn more about standard Wix errors.