Get schedule with the Outlook Calendar API

Returns the free and busy times of people, distribution lists or rooms between two times. In availabilityView each digit is one slot: 0 free or working elsewhere, 1 tentative, 2 busy, 3 out of office. scheduleItems lists the busy blocks and workingHours the working hours. Only work or school accounts can call it.

Identifier
outlook_calendar_get_schedule

The request

POST https://connect.reportei.com/api/tools/outlook_calendar_get_schedule/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "schedules": [],
    "startTime": {},
    "endTime": {}
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
schedulesarrayYesEmail addresses of the people, distribution lists or rooms.
startTimeobjectYesStart of the period.
endTimeobjectYesEnd of the period.
availabilityViewIntervalintegerNoMinutes per slot of availabilityView. The default is 30.

Supported connections

Your customer connects their Outlook Calendar account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/outlook_calendar, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/outlook_calendar_get_schedule. It becomes your agent's tool definition with no conversion.

Other Outlook Calendar tools

See all 10 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.