Microsoft: Get calendars from users — users Calendar list Calendars

Microsoft usersCalendar.listCalendars: arguments, response, policy and SDK examples.

← Users calendar operations · Get started

Operation microsoft.users_listcalendars

Provider route: GET /users/{user-id}/calendars. Alter supplies the connection’s credentials and routing.

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"]["listCalendars"]>[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.listCalendars(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from 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.list_calendars(arguments)
        result = await call.wait()
        return result.body_json()

Input

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
`query`	Model	Optional	Expand List rules — request body — query

Referenced models: List rules — request body — query

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 calendars — me Calendar list Calendars — response body

Referenced models: List calendars — me Calendar list Calendars — response body

Schemas

20 more schemas are linked from the tables above, on the schema pages.

List calendars — me Calendar list Calendars — 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 calendar — response body

Referenced models: List rules — response body — @odata count, @odata next Link, Get calendar — response body

List rules — request body — query

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`$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 calendar Permission — 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
`$ (allOf 2).@odata.type`	string	Optional
`$ (allOf 2).allowedRoles`	array	Optional	List of allowed sharing or delegating permission levels for the calendar. The possible values are: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom.
`$ (allOf 2).allowedRoles[]`	JSON	Each item
`$ (allOf 2).allowedRoles[] (anyOf 1)`	string	Alternative	Known values: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom
`$ (allOf 2).allowedRoles[] (anyOf 2)`	JSON	Alternative
`$ (allOf 2).allowedRoles[] (anyOf 2) (anyOf 1)`	object	Alternative
`$ (allOf 2).allowedRoles[] (anyOf 2) (anyOf 2)`	null	Alternative
`$ (allOf 2).emailAddress`	JSON	Optional	Represents a share recipient or delegate who has access to the calendar. For the 'My Organization' share recipient, the address property is null. Read-only.
`$ (allOf 2).emailAddress (anyOf 1)`	Model	Alternative	Expand Get calendar Permission — response body — @odata type, allowed Roles, email Address, is Inside Organization, is Removable, role email Address @odata type, address, name
`$ (allOf 2).emailAddress (anyOf 2)`	JSON	Alternative
`$ (allOf 2).emailAddress (anyOf 2) (anyOf 1)`	object	Alternative
`$ (allOf 2).emailAddress (anyOf 2) (anyOf 2)`	null	Alternative
`$ (allOf 2).isInsideOrganization`	JSON	Optional
`$ (allOf 2).isInsideOrganization (anyOf 1)`	boolean	Alternative	True if the user in context (recipient or delegate) is inside the same organization as the calendar owner.
`$ (allOf 2).isInsideOrganization (anyOf 2)`	null	Alternative
`$ (allOf 2).isRemovable`	JSON	Optional
`$ (allOf 2).isRemovable (anyOf 1)`	boolean	Alternative	True if the user can be removed from the list of recipients or delegates for the specified calendar, false otherwise. The 'My organization' user determines the permissions other people within your organization have to the given calendar. You can't remove 'My organization' as a share recipient to a calendar.
`$ (allOf 2).isRemovable (anyOf 2)`	null	Alternative
`$ (allOf 2).role`	JSON	Optional	Current permission level of the calendar share recipient or delegate.
`$ (allOf 2).role (anyOf 1)`	string	Alternative	Known values: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom
`$ (allOf 2).role (anyOf 2)`	JSON	Alternative
`$ (allOf 2).role (anyOf 2) (anyOf 1)`	object	Alternative
`$ (allOf 2).role (anyOf 2) (anyOf 2)`	null	Alternative

Referenced models: Get calendar Permission — response body — @odata type, allowed Roles, email Address, is Inside Organization, is Removable, role email Address @odata type, address, name, Get rule — response body — @odata type, id

Get calendar Permission — response body — @odata type, allowed Roles, email Address, is Inside Organization, is Removable, role email Address @odata type, address, name

Field	Type	Presence	Description and constraints
`$`	object	Root
`@odata.type`	string	Optional
`address`	JSON	Optional
`address (anyOf 1)`	string	Alternative	The email address of the person or entity.
`address (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The display name of the person or entity.
`name (anyOf 2)`	null	Alternative

Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count multi Value Extended Properties item

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
`$ (allOf 2).@odata.type`	string	Optional
`$ (allOf 2).value`	array	Optional	A collection of property values.
`$ (allOf 2).value[]`	JSON	Each item
`$ (allOf 2).value[] (anyOf 1)`	string	Alternative
`$ (allOf 2).value[] (anyOf 2)`	null	Alternative

Referenced models: Get rule — response body — @odata type, id

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
`$ (allOf 2).@odata.type`	string	Optional
`$ (allOf 2).value`	JSON	Optional
`$ (allOf 2).value (anyOf 1)`	string	Alternative	A property value.
`$ (allOf 2).value (anyOf 2)`	null	Alternative

Referenced models: Get rule — response body — @odata type, id

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

Create open extension — 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

Referenced models: Get rule — response body — @odata type, id

Policy, approvals and errors

SDK function policy ID: microsoft.users_listcalendars. Catalog operation: users_listcalendars. 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.ReadWrite", "Calendars.Read", "Calendars.Read.Shared"]

Official provider source

Report an issue with this page