Lists Deals for an account based on information sent via an http
form post.
| 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 | |
| apikey | true | API Key for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
| dealid | false | Filters query based on a specific deal (Optional) | |
| teammemberid | false | Must be numeric. ID of Team Member database that deal record belongs to. Leave blank for all account contacts. | |
| status | 1 | false | Filters query based on the deal status (Optional) Possible Values: 1=Active, 2=Won, 3=Lost, 4=Back Burner |
| dealid | false | Filters query based on a specific deal (Optional) | |
| dealtypeid | false | Filters query based on the dealtypeid (Optional) | |
| dealtypename | false | Filters query based on the name of the deal type (Optional) | |
| adddateafter | false | Enter a date is US Date / Time Format example: 4/24/2013 2:01PM Only deals added 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 | |
| closeddateafter | false | Enter a date is US Date example: 4/24/2013 Only deals with a CLOSED DATE on or after the date given will be returned. | |
| closeddatebefore | false | Enter a date is US Date example: 4/24/2013 Only deals with a CLOSED DATE on or before the date given will be returned. | |
| customfields | false | Set value to 1 to include each deal's custom fields in the results (new Feb 2015) | |
| relatedcontacts | false | Set value to 1 to include each deal's related contacts in the results |