> ## Documentation Index > Fetch the complete documentation index at: https://developer.lofty.com/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml openapi/openapi.json GET /v2.0/calendar openapi: 3.0.1 info: title: Lofty Service Open APIs description: Lofty service API description version: '1.0' servers: - url: https://api.lofty.com security: [] tags: - name: Tasks & Appointments V2 description: >- Unified V2 API for lead tasks and appointments: list, create, read, update, finish, unfinish and delete. Tasks and appointments share the same taskId namespace; each endpoint resolves the target by ID regardless of underlying type. - name: Opportunity description: Operations about opportunity - name: Communication V2 description: >- Fetch a single communication record (text / email / call) by its communication ID. Closes the webhook follow-up gap where only list-by-lead endpoints existed for text and email. - name: Vendor description: >- Team vendor directory: team members, sub-accounts and associated agents within the caller's team. - name: Lead Routing description: >- Lead routing configuration: read and update routing rules and default (supplement) rules per business type, and list the members and roles available for assignment. - name: Lead Activity V2 API description: >- Unified lead activity timeline: returns call, text and email activities for a lead in chronological order, including both auto-captured and agent-logged entries. - name: Tasks & Appointments description: >- Agent tasks and lead appointments. Supports listing a lead's appointments, listing / reading / creating / updating / deleting tasks on a lead. - name: Transactions V2 description: V2 transaction APIs. - name: Lead Manual Log description: >- Agent-recorded log of communications that happened outside the Lofty CRM (calls placed on a personal line, emails sent from another mailbox, SMS sent from another device). Three channels are supported: logCall, logEmail, logText. Direction fields are recorded from the agent's point of view: 'outbound' = agent -> lead, 'inbound' = lead -> agent. Persistence is asynchronous: a POST returns the new entry's ID once the write is enqueued, and the entry becomes readable after a short delay. - name: Calls description: >- Calls placed or received through the Lofty dialer. Supports fetching a recording URL, retrieving a single call record, and listing calls attached to a lead. - name: Listing V2 description: Listing search V2 - name: Agent User description: >- Agent onboarding and team directory operations. Create a new agent under the caller's team and attach tags to existing agents. - name: Sales Agents V2 description: >- Sales Agent (AI Assistant) management: read the caller's assistant and quota, query leads followed by AI, mute leads, manage working-pool membership and plan tasks, and update Sales Agent settings. - name: Calendar V2 API description: >- Unified V2 API for tasks and appointments on a lead: create, update, delete, finish, unfinish, query a paginated list, and find available meeting slots. Calendar IDs returned by POST /v2.0/calendar are composite strings of the form '-task' or '-appointment' and must be sent back as-is to the per-entry endpoints. - name: Lead System Logs description: Query a lead's system log. - name: Lead Transaction description: Operations about leads - name: Notifications V2 description: Operations for sending notifications to agents - name: Notes description: >- Free-text notes attached to a lead. Supports create, list, get-by-id, update and delete. Notes may be pinned to surface them at the top of the lead's timeline. System-generated notes (automated activity) are included on the list endpoint only when explicitly requested. - name: Listing description: >- Listing data access: retrieve published listings for a site feed (XML), and search active / sold listings by agent, office or MLS id. - name: Intelligent Features description: AI-powered features for lead analysis and communication - name: Leads description: >- Lead lifecycle operations: create / read / update / delete a lead, search leads by stage, source, tag, create time or update time, place an inquiry or property on a lead, list lead activities, resolve assignee by lead info, and handle Brokermint contact callbacks. - name: Members description: >- Team member directory: look up members by user ID, by account (email), or list all members of the caller's team. Also supports retrieving the current user's profile. - name: Team Features description: >- Team-scoped metadata: lead tags, custom fields, and lead ponds. Supports listing existing entries, adding a new custom field, and retrieving a specific lead pond. - name: Agent Organization description: >- Team organizational structure: read the caller's organization info, manage company and office records, and list permission profiles available to the team. - name: Communication description: >- Lead communication history and outbound messaging: list call / email / text history for a lead, search communications for an agent, and send SMS or email to a lead. - name: Webhooks description: > Use webhooks to be notified about events that happen in a lofty account. Supported webhook event types (listId): | listId | Event Type | Description | |--------|-----------|-------------| | 1 | Agent Info | Agent created or updated | | 2 | Lead Info | Lead created, updated, or deleted | | 3 | Lead Activity | Lead site activity (e.g. SiteBrowse, SiteFavorite, SiteSearch) | | 4 | Listing Alert | Listing alert changed | | 5 | Transaction | Transaction created, updated, or deleted | | 6 | Call | Call event (MANUAL and LOGGED only, excludes AUTO) | | 7 | Email | Email event (MANUAL and LOGGED only, excludes AUTO) | | 8 | Text | Text message event (MANUAL and LOGGED only, excludes AUTO) | | 9 | Note | Note created, updated, or deleted | | 10 | Task | Task created, updated, finished, or deleted | | 11 | Appointment | Appointment created, updated, finished, or deleted | | 12 | Pipeline Change | Lead pipeline stage changed | ### Notification Recipient Rules Here "team" means the entire Lofty client account (the organization), not the Lofty "Team add-on" product. Which subscribed users receive a callback depends on the subscription's delivery mode (`permissionMode`). In both modes, only users in the lead's account (team) who have subscribed to the event type are considered. **Assignment-based delivery — `permissionMode: 0` (default)** A subscriber receives the callback only for leads assigned to them or that they administer: - If the lead is a **hidden lead**, only the **assigned agent** receives the notification. - Otherwise, the subscriber receives it if they are the **assigned agent** of the lead, or a **Company Owner** or **Company Admin**. - All other subscribers do **not** receive the notification. **Ownership-based delivery — `permissionMode: 1`** A subscriber receives the callback for any lead they manage, regardless of who it is assigned to: - Every assignment-based case above still applies (assigned agent, Company Owner / Company Admin). - In addition, the subscriber receives the callback for any lead within their **ownership scope** — a lead owned by their **team** or **office**, or **personally owned** by them — even if it is assigned to someone else. - Hidden leads are still delivered only to users who manage them. Ownership-based mode is intended for team/account-level integrations that must cover every lead in their scope, not only assigned leads. Set `permissionMode` when creating the subscription (POST /v1.0/webhook); it defaults to `0`, so existing subscriptions are unaffected. ### Delivery Timing Webhooks are typically delivered within **1 minute** of the event being triggered. During periods of high traffic, delivery may be delayed, but will always be sent within **5 minutes**. For detailed callback payload structures, see [Webhook Event Payloads](/concepts/webhooks#event-payloads). paths: /v2.0/calendar: get: tags: - Calendar V2 API summary: List Calendar Events description: >- 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. operationId: queryCalendars parameters: - name: leadId in: query description: Lead ID (optional, filter by specific lead) required: false schema: type: string description: Lead ID (optional, filter by specific lead) example: 123456 example: 123456 - name: startTime in: query description: >- Start time, ISO 8601 with offset. At least one of startTime or endTime is required. required: false schema: type: string description: >- Start time, ISO 8601 with offset. At least one of startTime or endTime is required. example: '2026-01-01T00:00:00+08:00' example: '2026-01-01T00:00:00+08:00' - name: endTime in: query description: >- End time, ISO 8601 with offset. At least one of startTime or endTime is required. required: false schema: type: string description: >- End time, ISO 8601 with offset. At least one of startTime or endTime is required. example: '2026-12-31T23:59:59+08:00' example: '2026-12-31T23:59:59+08:00' - name: startTimeMs in: query description: >- Start time as Unix timestamp in milliseconds. Used when startTime is not provided. required: false schema: type: string description: >- Start time as Unix timestamp in milliseconds. Used when startTime is not provided. example: 1704038400000 example: 1704038400000 - name: endTimeMs in: query description: >- End time as Unix timestamp in milliseconds. Used when endTime is not provided. required: false schema: type: string description: >- End time as Unix timestamp in milliseconds. Used when endTime is not provided. example: 1735660799000 example: 1735660799000 - name: timeZoneCode in: query description: Timezone code (IANA format, e.g., America/Los_Angeles) required: false schema: type: string description: Timezone code (IANA format, e.g., America/Los_Angeles) example: America/Los_Angeles example: America/Los_Angeles - name: includeFinished in: query description: Include finished calendars required: false schema: type: string description: Include finished calendars example: false default: 'false' example: false - name: page in: query description: Page number (starts from 0) required: false schema: type: string description: Page number (starts from 0) example: 0 default: '0' example: 0 - name: pageSize in: query description: Page size (max 500) required: false schema: type: string description: Page size (max 500) example: 20 example: 20 - name: sort in: query description: Sort field (e.g., startTime) required: false schema: type: string description: Sort field (e.g., startTime) example: startTime default: startTime example: startTime - name: desc in: query description: Sort in descending order required: false schema: type: string description: Sort in descending order example: true default: 'true' example: true - name: sourceType in: query description: Filter by source type codes. Multiple values allowed. required: false schema: type: string description: Filter by source type codes. Multiple values allowed. example: - 1 - 2 - 4 example: - 1 - 2 - 4 - name: Authorization in: header description: Bearer [access_token] required: true schema: type: string responses: '200': description: Page of calendar entries with pagination metadata. content: application/json: schema: $ref: '#/components/schemas/CalendarListResponseEnvelope' '400': description: Invalid parameters (20012 INVALID_PARAMETER). content: '*/*': schema: type: string '401': description: Missing or invalid authentication token. content: '*/*': schema: type: string '500': description: Internal server error. content: '*/*': schema: type: string components: schemas: CalendarListResponseEnvelope: type: object properties: data: $ref: '#/components/schemas/CalendarListResponseV2' description: >- Response envelope for GET /v2.0/calendar. Wraps the paginated calendar list under the 'data' field. CalendarListResponseV2: type: object properties: total: type: integer description: Total count of calendars matching the query format: int64 example: 100 page: type: integer description: Current page number (starts from 0) format: int32 example: 0 pageSize: type: integer description: Page size format: int32 example: 20 items: type: array description: List of calendar items items: $ref: '#/components/schemas/CalendarItemV2' description: Calendar list response with pagination CalendarItemV2: type: object properties: id: type: string description: >- Calendar ID with type suffix (e.g., '12345-task' or '12345-appointment') example: 12345-task type: type: string description: Calendar type for identification only (TASK or APPOINTMENT) example: TASK taskId: type: integer description: Task ID associated with the calendar item format: int64 sourceType: type: integer description: Source type code from calendar system format: int32 content: type: string description: Event content/description title: type: string description: Event title (auto-generated from lead name + event type) finished: type: boolean description: Whether the calendar item is finished example: false startAt: type: string description: Start time in ISO8601 format endAt: type: string description: End time in ISO8601 format startAtMs: type: integer description: Start time as Unix timestamp in milliseconds format: int64 endAtMs: type: integer description: End time as Unix timestamp in milliseconds format: int64 timeZoneCode: type: string description: Timezone code leadId: type: integer description: Lead ID format: int64 example: 1234567890 description: >- Unified calendar item representing Task, Appointment, or other calendar events ````