/contacts/query [deprecated]

Searches for people and groups to address an email to, the way the Mixmax recipient field does. It returns up to 5 of your own contacts whose name or email words start with q, ranked by how recently and how often you used them, plus matching contact groups and teams.

With a connected Salesforce account it can also add matching Salesforce contacts and leads, accounts, and opportunities. Without one, those flags are ignored and their lists are empty.

This operation is deprecated. It has no replacement in the public API, and no removal date has been announced.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The text to search for. Each space-separated word must match the start of a word in the contact's name or email. Without it, every list is empty.

boolean
Defaults to false

true to add Salesforce contacts and leads that match q. A Salesforce record with the same email as a Mixmax contact merges its fields into that contact's meta and sets its origin to salesforce.

boolean
Defaults to false

true to list Salesforce accounts whose name starts with q.

boolean
Defaults to false

true to list Salesforce opportunities whose name starts with q.

boolean
Defaults to false

true to add matching Pipedrive persons. Ignored unless Pipedrive is connected.

boolean
Defaults to false

true to return only contacts that have a phone number in meta.

string

Comma-separated emails to rank first when they start with q. The same contact can then appear twice in contacts.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
Psst... like working with APIs? Come join us!