Sign in

v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Calendar V2 API

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.
get/v2.0/calendar

Query parameters

leadIdstring

Lead ID (optional, filter by specific lead)

Lead ID (optional, filter by specific lead)

startTimestring

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

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

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

endTimestring

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

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

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

startTimeMsstring

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

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

endTimeMsstring

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

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

timeZoneCodestring

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

Example:America/Los_Angeles

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

includeFinishedstring

Include finished calendars

Include finished calendars

pagestring

Page number (starts from 0)

Page number (starts from 0)

pageSizestring

Page size (max 500)

Page size (max 500)

sortstring

Sort field (e.g., startTime)

Example:startTime

Sort field (e.g., startTime)

descstring

Sort in descending order

Sort in descending order

sourceTypestring

Filter by source type codes. Multiple values allowed.

Filter by source type codes. Multiple values allowed.

Headers

Authorizationstring required

Bearer [access_token]

Response

Page of calendar entries with pagination metadata.

Example response

{
  "data": {
    "total": 100,
    "pageSize": 20,
    "items": [
      {
        "id": "12345-task",
        "type": "TASK",
        "leadId": 1234567890
      }
    ]
  }
}