Sign in

v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Tasks & Appointments

List Appointments

Returns appointments attached to the given lead. Caller must have manage permission on the lead.

get/v1.0/appts

Query parameters

leadIdinteger required

ID of the lead whose appointments to return.

Headers

Authorizationstring required

Bearer [access_token]

Response

Appointments for the lead.

idinteger

The Id of the appointment

descrstring

The description of the appointment

addressstring

The location of the appointment

createTimestring date-time

The create time of the appointment

lastUpdatestring date-time

The last update time of the appointment

deadlineinteger

The start time of the appointment

endTimeinteger

The end time of the appointment

allDayboolean

Whether the appointment time is all day

finishFlagboolean

If the appointment is finished or not

deleteFlagboolean

If the appointment is deleted or not

overdueboolean

If the appointment is overdue or not

finishTimeinteger

The finish time of the task

leadIdinteger

The lead(Id) associated with the appointment

assignToUidinteger

The user's Id of the appointment assigned to

assignRoleTypeinteger

The user role of the appointment assigned to

creatorIdinteger

The user ID of this appointment creator