Skip to main content
GET
List Calendar Events

Headers

Authorization
string
required

Bearer [access_token]

Query Parameters

leadId
string

Lead ID (optional, filter by specific lead)

Example:

123456

startTime
string

Start time, ISO 8601 with offset. At least one of startTime or endTime is required.

Example:

"2026-01-01T00:00:00+08:00"

endTime
string

End time, ISO 8601 with offset. At least one of startTime or endTime is required.

Example:

"2026-12-31T23:59:59+08:00"

startTimeMs
string

Start time as Unix timestamp in milliseconds. Used when startTime is not provided.

Example:

1704038400000

endTimeMs
string

End time as Unix timestamp in milliseconds. Used when endTime is not provided.

Example:

1735660799000

timeZoneCode
string

Timezone code (IANA format, e.g., America/Los_Angeles)

Example:

"America/Los_Angeles"

includeFinished
string
default:false

Include finished calendars

Example:

false

page
string
default:0

Page number (starts from 0)

Example:

0

pageSize
string

Page size (max 500)

Example:

20

sort
string
default:startTime

Sort field (e.g., startTime)

Example:

"startTime"

desc
string
default:true

Sort in descending order

Example:

true

sourceType
string

Filter by source type codes. Multiple values allowed.

Example:

Response

Page of calendar entries with pagination metadata.

Response envelope for GET /v2.0/calendar. Wraps the paginated calendar list under the 'data' field.

data
object

Calendar list response with pagination