View as Markdown
Microsoft Outlook Calendar icon

Microsoft Outlook Calendar ACTION

Get Free/Busy Schedule

Get the free/busy availability information for a collection of users, distributions lists, or resources (rooms or equipment) for a specified time period. 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 Get Free/Busy Schedule 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-get-schedule",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    microsoft_outlook_calendar: { authProvisionId: "apn_xxxxxxx" },
    schedules: ["Schedules"],
    start: "Start",
  },
})

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.

Get Free/Busy Schedule inputs
Property Type Description
schedules Schedules string[]
A list of emails of users, distribution lists, or resources. For example: [ "adelev@contoso.com" , "meganb@contoso.com" ]
Required
start Start string
Start date-time (yyyy-MM-ddThh:mm:ss) e.g. '2022-04-15T11:20:00'
Required
end End string
End date-time (yyyy-MM-ddThh:mm:ss) e.g. '2022-04-15T13:30:00'
Required
timeZone Time Zone string
Time zone of the event in supported time zones, See the docs
Required Dynamic
availabilityViewInterval Availability View Interval integer
Represents the duration of a time slot in minutes in an availabilityView in the response. The default is 30 minutes, minimum is 5, maximum is 1440.
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-get-schedule
Version
0.0.13
App
Microsoft Outlook Calendar
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes