Microsoft: Get calendar View from users — users Calendar calendars List Calendar View
Microsoft usersCalendar.calendarsListCalendarView: arguments, response, policy and SDK examples.
← Users calendar operations · Get started
Operation microsoft.users_calendars_listcalendarview
Provider route: GET /users/{user-id}/calendars/{calendar-id}/calendarView. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/microsoft with npm, or alter-sdk-microsoft with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { MicrosoftIntegration } from "@alter-ai/microsoft";
async function execute(input: Parameters<MicrosoftIntegration["usersCalendar"]["calendarsListCalendarView"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new MicrosoftIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.usersCalendar.calendarsListCalendarView(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_microsoft import MicrosoftIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = MicrosoftIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.users_calendar.calendars_list_calendar_view(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.user-id | string | Required within parent | |
path.calendar-id | string | Required within parent | |
query | Model | Required within parent | Expand List instances — request body — query |
Referenced models: List instances — request body — query
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand List instances — response body |
Referenced models: List instances — response body
Schemas
Section titled “Schemas”23 more schemas are linked from the tables above, on the schema pages.
List instances — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | Model | All variants apply | Expand List rules — response body — @odata count, @odata next Link |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).value | array | Optional | |
$ (allOf 2).value[] | Model | Each item | Expand Get event — response body |
Referenced models: List rules — response body — @odata count, @odata next Link, Get event — response body
List instances — request body — query
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
startDateTime | string | Required within parent | |
endDateTime | string | Required within parent | |
$top | integer | Optional | Minimum: 0 |
$skip | integer | Optional | Minimum: 0 |
$search | string | Optional | |
$filter | string | Optional | |
$count | boolean | Optional | |
$orderby | array | Optional | Unique items: true |
$orderby[] | string | Each item | |
$select | array | Optional | Unique items: true |
$select[] | string | Each item | |
$expand | array | Optional | Unique items: true |
$expand[] | string | Each item | |
$skiptoken | string | Optional |
List rules — response body — @odata count, @odata next Link
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.count | JSON | Optional | |
@odata.count (anyOf 1) | JSON | Alternative | |
@odata.count (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
@odata.count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
@odata.count (anyOf 2) | null | Alternative | |
@odata.nextLink | JSON | Optional | |
@odata.nextLink (anyOf 1) | string | Alternative | |
@odata.nextLink (anyOf 2) | null | Alternative |
Get attachment — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get rule — response body — @odata type, id |
$ (allOf 2) | object | All variants apply | discriminator: {"mapping": {}, "propertyName": "@odata.type"} |
$ (allOf 2).@odata.type | string | Optional | |
$ (allOf 2).contentType | JSON | Optional | |
$ (allOf 2).contentType (anyOf 1) | string | Alternative | The MIME type. |
$ (allOf 2).contentType (anyOf 2) | null | Alternative | |
$ (allOf 2).isInline | boolean | Optional | true if the attachment is an inline attachment; otherwise, false. |
$ (allOf 2).lastModifiedDateTime | JSON | Optional | |
$ (allOf 2).lastModifiedDateTime (anyOf 1) | string | Alternative | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z Format: date-time Pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ |
$ (allOf 2).lastModifiedDateTime (anyOf 2) | null | Alternative | |
$ (allOf 2).name | JSON | Optional | |
$ (allOf 2).name (anyOf 1) | string | Alternative | The attachment's file name. |
$ (allOf 2).name (anyOf 2) | null | Alternative | |
$ (allOf 2).size | JSON | Optional | |
$ (allOf 2).size (anyOf 1) | number | Alternative | The length of the attachment in bytes. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
$ (allOf 2).size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Get rule — response body — @odata type, id
Get event — response body — @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link attendees item
Referenced models: Get event — response body — @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link attendees item @odata type, email Address, type, Get event — response body — @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link response Status @odata type, response, time, Invoke action decline — me Event events Decline — request body — body Proposed New Time @odata type, end, start
Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.type | string | Optional | |
dateTime | string | Optional | A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000). |
timeZone | JSON | Optional | |
timeZone (anyOf 1) | string | Alternative | Represents a time zone, for example, 'Pacific Standard Time'. See below for more possible values. |
timeZone (anyOf 2) | null | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: microsoft.users_calendars_listcalendarview. Catalog operation: users_calendars_listcalendarview. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["Calendars.Read", "Calendars.ReadWrite"]