List Calendar Events
Returns a page of calendar entries (Tasks and Appointments) for the caller, optionally filtered by leadId, type and completion status.
Notes:
- At least one of startTime or endTime is required; requests missing both return 400 INVALID_PARAMETER.
- includeFinished=true returns both finished and unfinished entries; includeFinished=false returns only unfinished.
- Results are wrapped under the ‘data’ key, which also carries pagination metadata.
Headers
Bearer [access_token]
Query Parameters
Lead ID (optional, filter by specific lead)
123456
Start time, ISO 8601 with offset. At least one of startTime or endTime is required.
"2026-01-01T00:00:00+08:00"
End time, ISO 8601 with offset. At least one of startTime or endTime is required.
"2026-12-31T23:59:59+08:00"
Start time as Unix timestamp in milliseconds. Used when startTime is not provided.
1704038400000
End time as Unix timestamp in milliseconds. Used when endTime is not provided.
1735660799000
Timezone code (IANA format, e.g., America/Los_Angeles)
"America/Los_Angeles"
Include finished calendars
false
Page number (starts from 0)
0
Page size (max 500)
20
Sort field (e.g., startTime)
"startTime"
Sort in descending order
true
Filter by source type codes. Multiple values allowed.
Response
Page of calendar entries with pagination metadata.
Response envelope for GET /v2.0/calendar. Wraps the paginated calendar list under the 'data' field.
Calendar list response with pagination