POST

Query Contacts

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 order
  • paging.limit is 50
  • paging.offset is 0

For 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.

Authentication

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

Permissions
Manage Challenges
Set Up Automations
Manage Members and Contacts - all permissions
Read Members and Contacts - all read permissions
Manage Contacts
Read Contacts
Manage Events
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/contacts/v4/contacts/query
Errors
400Invalid Argument

There are 8 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?