{"_id":"5a2f1c31b47baa001c646fdd","project":"5588b8a2f6c18d0d005bba03","version":{"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":16,"createdAt":"2015-06-23T01:38:42.696Z","releaseDate":"2015-06-23T01:38:42.696Z","categories":["5588b8a3f6c18d0d005bba07","5588e9689cfea70d00371df3","5588f5921163180d00b64704","561598b121e9110d0078025a","5616f1c9d170d00d00189306","5616f5c3a410c90d00c6121e","561803dcf8c9632100ac7592","563667280441020d0000e9eb","5642570d9417b40d00c0fcd3","57bf5f02efe0050e00d50bd5","57f53fb368a53b2000e03f0f","57f55187440418170086325a","582e3afa72fd270f0006926d","5841faa973967b0f004b4a2b","58db348aa32c8419002433bb","5a31c9409a6f2000125c079f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"57f53fb368a53b2000e03f0f","version":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-10-05T18:00:19.547Z","from_sync":false,"order":0,"slug":"api","title":"REST API: Access your Mixmax data"},"user":"5588b847f6c18d0d005bba01","__v":3,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-12-12T00:00:49.777Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\"isSynced\":true,\"contacts\":[{\"name\":\"Hello Mixmax\",\"email\":\"hello:::at:::mixmax.com\"}],\"domains\":[],\"groups\":[]}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a2f1c31b47baa001c646fdf","ref":"","in":"query","required":false,"desc":"The string to search","default":"","type":"string","name":"q"},{"_id":"5a2f1fbe56878f001282167e","ref":"","in":"query","required":false,"desc":"Whether to include Salesforce data in the query results if it exists.","default":"false","type":"string","name":"includeSalesforceContacts"},{"_id":"5a2f1fbe56878f001282167d","ref":"","in":"query","required":false,"desc":"Whether to include a list of matching Salesforce Accounts in the query results","default":"false","type":"boolean","name":"includeSalesforceAccounts"},{"_id":"5a2f1fbe56878f001282167c","ref":"","in":"query","required":false,"desc":"Whether to include a list of matching Salesforce Opportunities in the results.","default":"false","type":"boolean","name":"includeSalesforceOpportunities"}],"url":"/contacts/query"},"isReference":true,"order":13,"body":"","excerpt":"Search for matching contacts","slug":"contactsquery","type":"endpoint","title":"/contacts/query"}

get/contacts/query

Search for matching contacts

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

q:
string
The string to search
includeSalesforceContacts:
stringfalse
Whether to include Salesforce data in the query results if it exists.
includeSalesforceAccounts:
booleanfalse
Whether to include a list of matching Salesforce Accounts in the query results
includeSalesforceOpportunities:
booleanfalse
Whether to include a list of matching Salesforce Opportunities in the results.

Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}