Lists all your Mixmax Contacts (ie people you've emailed using Mixmax). Does not currently return contacts shared with you via shared contact groups (a performance limitiation).
Deprecated
This endpoint is now marked for deprecation. While this endpoint is still functional, it will be phased out in the future and should not be used in new development efforts.
A Mixmax contact is automatically created for every person you communicate with in Mixmax. Contacts are also synced from Google Contacts and Salesforce lists automatically.
Email addresses can be associated with only one contact
Currently a contact can only have one email address, and that email address cannot be used for another contact.
| Parameter | Type | Description |
|---|---|---|
| _id | String | Unique ID |
| userId | String | Your user id |
| String | Email address for the contact. Addresses are always lowercase. This is unique per user - there will only ever be one contact per email address per Mixmax user. Can be specified as a single email or as a String list of comma-separated emails. | |
| name | String | Name for the contact, or null if it isn't set |
| timestamp | Timestamp | Unix timestamp of when the contact was last emailed |
| usedCount | Number | The number of times this person was contacted. |
| contactId | String | Google ID that this contact is associated with, if a contact exists in Google Contacts for this same email address. |
| salesforceId | String | Salesforce ID that this contact is associated with, if a contact exists in Salesforce (either contact or a lead) for this same email address. |
| meta | Object | Contact variables from any source (ex. Salesforce) that are used to populate sequences and templates variables. If expand is set in the query with 'firstName' or 'lastName', then it will populate 'First Name' and 'Last Name' metadata properties if they not exist already. The values for these fields will be derived from the Contact's name. If expand is set with 'salesforce' it will populate meta values from the connected salesforce instance if a salesforce Contact or Lead exists for this mixmax contact. |
| analytics | Object | Analytics for the contact. |
| locked | String[] | A list of uneditable fields for this contact. These custom fields, if added, will be overridden in template insertion. |
Searching
The search string will match either email or the name of the contact. In addition, the following search operators are supported (see below). Multiple-word values for search operators must be escaped in quotes (e.g. name:"brad vogel").
| What you can search by | Search operator & example |
|---|---|
| The contact's email address | email:[email protected] or email:[email protected],[email protected]Exact email required. Matches case-insensitively. |
| The contact's full name | name:MixmaxPartial match on contact name. Matches case-insensitively. Only one name: search operator supported. |
| Groups the contact is in | groups:"my group name"Exact, case-sensitive match on group name. If multiple group: search operators passed they will be treated as an AND (i.e. contacts returned must be in all groups). |