Overview
Returns the resulting number of contacts for a specified saved search based on information sent via an http form post.
Special Notes
This can be a highly intensive API function. Some saved searches can be slow, so please keep that in mind when designing your application.
Post Url
https://www.allclients.com/api/2/GetSavedSearchCount.aspx
- SSL is requred
- White Label CRM Customers: Replace www.allclients.com with your White Label CRM domain name.
Form Fields
Field | Max Length* | Required | Notes |
response_type | No | Default results will be returned in XML.
Set this field value to json to return results in JSON format |
|
accountid | Yes | Must be numeric. Account ID for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
teammemberid | No | Default is 0 for Account Owner | |
apikey | Yes | API Key for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
savedsearchid | Yes | ||
overridecache | No | Set to “1” to override 15 minute cache for result count. Not recommended unless you’ve consulted with AllClients Developers |
Sample Results
<results>
<savedsearch>
<id>121</id>
<name>Hot Prospects</name>
<count>27</count>
<searchurl>ContactList.aspx?Mode=Advanced&ss=121</searchurl>
<cached>True</cached>
</savedsearch>
</results>
Sample Failure Message
<?xml version="1.0"?>
<results>
<error>Authentication failed</error>
</results>