GET

Find Matching 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 that match the provided identifiers.

Matching uses externalId, email, and phone to find contacts that likely represent the same person. Provide at least one identifier.

Results are ordered by match strength: contacts matching more or higher-priority identifiers appear first. Within each group, contacts are ordered by creation date, oldest first. Identifier priority is externalId (highest), then email, then phone (lowest).

Learn more about contact matching.

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
GET
https://www.wixapis.com/contacts/v5/contacts/find-matching

Errors
428Failed Precondition

There is 1 error with this status code.

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

Did this help?