Retrieve appointment data within date ranges, with some related data.
Intended for reporting data. Communication handled via an http form post.
Field | Max Length | Required | Notes |
---|---|---|---|
response_type | true | Default results will be returned in XML. Set this field value to json to return results in JSON format | |
accountid | true | Account ID for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
teammemberid | false | Optional Team Member ID filter | |
contactid | false | Optional Contact ID filter | |
apikey | true | API Key for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
startdate | 10 | true | Add Date of the contact is on or after this date (Use US date format: mm/dd/yyyy) |
enddate | 10 | true | Add Date of the contact is before this date (Use US date format: mm/dd/yyyy) Note: Using value 6/30/2012 will not include contacts added on 6/30. Use 7/1/2013 to include contacts added BEFORE this date. |
detail | 1 | false | Set this value to "1" to return the description, details, and color fields for each appointment |