Get event with the Outlook Calendar API
Returns one event with its body as plain text, start and end in UTC, location, attendees with their responses, organizer, onlineMeeting with the join link, recurrence and webLink.
- Identifier
- outlook_calendar_get_event
The request
POST https://connect.reportei.com/api/tools/outlook_calendar_get_event/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"event_id": "<event_id>"
}
}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
| Parameter | Type | Required | Description |
|---|---|---|---|
| event_id | string | Yes | Event id from List events. The id of an occurrence acts on that occurrence; its seriesMasterId acts on the whole series. |
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_event. It becomes your agent's tool definition with no conversion.
Other Outlook Calendar tools
- List calendarsGETLists the calendars of the user, with id, name, isDefaultCalendar, canEdit and owner. Use the id as calendar_id. Only the first page comes back.
- List eventsGETLists the events of a calendar between two times, with recurring events expanded into occurrences that have their own id. start and end come in UTC. Only the first page comes back: when the response has @odata.nextLink, ask again with a shorter window.
- Create eventPOSTCreates an event in a calendar and returns it with its id and webLink. With attendees, Outlook emails the invitations right away, and this cannot be turned off.
- Update eventPATCHChanges an event and returns it. Only the fields sent change. On a meeting the user organizes, Outlook emails the change to the attendees. Do not send a new body for an online meeting: the join details live in the body and would be lost.
- Delete eventDELETEDeletes an event from the calendar. When the user organizes the meeting, Outlook emails a cancellation to the attendees.
- Accept eventPOSTAccepts a meeting invitation and, unless sendResponse is false, emails the response to the organizer. The response is 202 with no body.
- Decline eventPOSTDeclines a meeting invitation, optionally proposing another time, and unless sendResponse is false emails the response to the organizer. The response is 202 with no body.
- Tentatively accept eventPOSTTentatively accepts a meeting invitation, optionally proposing another time, and unless sendResponse is false emails the response to the organizer. The response is 202 with no body.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
