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.
| Property | Filters | Sort |
|---|---|---|
_id | $eq, $ne, $in, $exists | None |
info.locale | $eq, $ne, $in, $exists | None |
_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 | None |
primaryInfo.email | $eq, $ne, $in, $exists, $startsWith | Sort: ASC, DESC |
info.name.first | $eq, $ne, $in, $exists, $startsWith | Sort: ASC, DESC |
info.name.last | $eq, $ne, $in, $exists, $startsWith | Sort: ASC, DESC |
info.company | $eq, $ne, $in, $exists, $startsWith | Sort: ASC, DESC |
info.jobTitle | $eq, $ne, $in, $exists, $startsWith | Sort: ASC, DESC |
primaryInfo.phone | $eq, $ne, $in, $exists, $startsWith | None |
info.labelKeys | $hasSome, $hasAll | None |
This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:
There are 8 errors with this status code.
This method may also return standard errors. Learn more about standard Wix errors.