Search for a Person record by email using the Mercury API

Use this guide to search your existing Mercury Person (Contacts) records by email address using a GET API request. This is useful when you need to confirm whether a person already exists before creating or updating records.

The Person search API allows you to query the Mercury Contacts database using specific search parameters, such as an email address. It returns any matching Person records in the response.

This helps you avoid duplicate records and ensures data consistency across your integrations.

To search for a Person record, use a GET request with search=true and include the email address in the searchParams query parameter.

The email address must be passed as a URL-encoded JSON object.

Use the following format when making your API call:

GET https://apis.connective.com.au/mercury/v1/:token/contacts?search=true&searchParams=%7B%22email%22%3A%[email protected]%22%7D

Replace:

When the request is successful, Mercury searches the Contacts database for records matching the email address and returns a list of matching Person records in the API response.

If no records are found, the response will return an empty result set.

Tip: Use this search before creating a new Person record to reduce duplicate contacts.

Important: Ensure your API key and token are valid and have permission to access Contacts data.

Check that your searchParams value is correctly URL encoded and that the email address is formatted correctly.

If you need help using the Mercury API or troubleshooting API access, contact your Partnership Manager or email [email protected].