View as Markdown
Microsoft Outlook Calendar icon

Microsoft Outlook Calendar ACTION

List Events

Get a list of event objects in the user's mailbox. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Microsoft Outlook Calendar account once, then configure and run List Events from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "microsoft_outlook_calendar-list-events",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    microsoft_outlook_calendar: { authProvisionId: "apn_xxxxxxx" },
    filter: "Filter",
    orderBy: "Order By",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Events inputs
Property Type Description
filter Filter string
Filters results using OData syntax. For example, contains(subject, 'meet for lunch?') will include events whose title contains 'meet for lunch?'. See documentation for the full list of operations. Note: filtering on the recurrence property is not supported by the API.
Optional
orderBy Order By string
Orders results. For example, displayName desc will sort the results by Display Name in decending order.
Optional
maxResults Max Results integer
The maximum number of results to return
Optional
includeRecurring Include Recurring boolean
When true, uses the calendar view endpoint which expands each occurrence of a recurring event into its own individual result. Requires Start Date Time and End Date Time. When false or unset, the events endpoint is used instead, which returns recurring series as a single master entry — these are excluded from the results. Start Date Time and End Date Time can still be used to filter by date range.
Optional
startDateTime Start Date Time string
Filter events that start at or after this date and time, in ISO 8601 format (e.g. 2019-11-08T19:00:00-08:00). Required when Include Recurring is true. When Include Recurring is false or unset, this adds a start/dateTime ge filter to the events endpoint.
Optional
endDateTime End Date Time string
Filter events that end at or before this date and time, in ISO 8601 format (e.g. 2019-11-08T20:00:00-08:00). Required when Include Recurring is true. When Include Recurring is false or unset, this adds an end/dateTime le filter to the events endpoint.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
microsoft_outlook_calendar-list-events
Version
0.1.2
App
Microsoft Outlook Calendar
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes