POST

Query Contacts


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

Query Contacts runs with these defaults, which you can override:

  • createdDate is sorted in DESC order
  • paging.limit is 50

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

PropertyFiltersSort
id$eq, $inNone
createdDate$eq, $gt, $lt, $gte, $lteSort: ASC
updatedDate$eq, $gt, $lt, $gte, $lteSort: ASC
email.email$eq, $in, $existsNone
phone.phone$eq, $in, $existsNone
externalId$eq, $in, $existsNone
Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Read Contacts
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/contacts/v5/contacts/query

Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?