Lists contact or contacts based on information sent via an http form post.
This function is designed for speed — searching only First Name, Last Name, Other First Name, Other Last Name, Email Address, and Other Email Address. It also returns only a limited number of fields and is limited to 50 results returned. This would be best used in some kind of "type-along-find" Ajax contact picker. Lower the "max results" to an even lower number to speed up the results even further.
Update 6/1/2017 - When the searchstring contains a space, the search will split the field in two and assume that it is a "first name+last name" "begins with" search. A searchstring of "jo sm" with search for contacts with first names beginning with "jo" and last names beginning with "sm"
| Field | Max Length | Required | Notes |
|---|---|---|---|
| response_type | false | Default results will be returned in XML. Set this field value to json to return results in JSON format | |
| accountid | true | Must be numeric. Account ID for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
| teammemberid | false | Default is 0 for Account Owner Use -1 to search across all team member databases | |
| apikey | true | API Key for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
| searchstring | true | String to search contact for. Search will search First Name, Last Name, Other First Name, Other Last Name, and Email Address | |
| maxresults | false | Number of results to return. Specify between 1 and 50. Default is 20 results. |