Lists To Do Summary based on information sent via an http form post.
Special Note: This function will only return the first 2,500 To Dos based on the selection criteria. If you have more than 2,500 To Dos, you will need to narrow your criteria
- SSL is requred
- White Label CRM Customers: Replace www.allclients.com with your White Label CRM domain name.
|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 OwnerUse -1 to return all To Dos regardless of which Team Member they are assigned to.|
|apikey||Yes||API Key for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel|
|contactid||No||(Optional) Filter the the list to a specific contact|
open – only include open To Dos (default)
closed – only include closed To Dos
all – include all To Dos, regardless of status
|aftereditdate||No||Enter a date is US Date / Time Format example: 4/24/2013 2:01PM
Only To Dos edited after the date given will be returned.
4/24/2013 assumes midnight, so anything added on or after 4/24/2013 would be included.
Time Zone for Add Date is US Central Time
<emailtemplateid> and <emailtemplatename> will be returned if the To Do is linked to a Email Template
<letterid> and <lettername> will be returned if the To Do is linked to a Letter Template
<results> <todos> <todo> <todoid>540234</todoid> <teammemberid>0</teammemberid> <contactid>4232</contactid> <priority>1</priority> <summary>Call about order</summary> <status>closed</status> <details>Karen was interested in ordering new furniture</details> <duedate>12/3/2014</duedate> <completedate>12/2/2014</completedate> <category>Email</category> <emailtemplateid>2343</emailtemplateid> <emailtemplatename>New Order Follow Up</emailtemplatename> <letterid></letterid> <todo> </todos> </results>
Sample Failure Message
<?xml version="1.0"?> <results> <error>Authentication failed</error> </results>