GetAppointments

Overview

Retrieve a list of appointments for an account, with optional filters for date range, contact, and team member.

Results are capped at 500. If the result is capped, a element will be returned with a value of true. It is recommended to use date range, contact, or team member filters rather than attempting to retrieve all calendar items at once.

URL

POST/api/2/GetAppointments/ or legacy URL at /api/2/GetAppointments.aspx

form-data Parameters

Field	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
startdate	false	Format mm/dd/yyyy. Filter appointments starting on or after this date.
enddate	false	Format mm/dd/yyyy. Filter appointments starting before or on this date.
contactid	false	Must be numeric. Filter appointments by a specific contact ID
teammemberid	false	Must be numeric. Filter appointments by a specific team member (0 = Account Owner)