Skip to content

Microsoft: Get calendar Group

Microsoft meCalendarGroup.getCalendarGroups: arguments, response, policy and SDK examples.

← Me calendar group operations · Get started

Operation microsoft.me_getcalendargroups

Provider route: GET /me/calendarGroups/{calendarGroup-id}. Alter supplies the connection’s credentials and routing.

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["meCalendarGroup"]["getCalendarGroups"]>[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.meCalendarGroup.getCalendarGroups(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.me_calendar_group.get_calendar_groups(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.calendarGroup-idstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.$selectarrayOptionalUnique items: true
query.$select[]stringEach item
query.$expandarrayOptionalUnique items: true
query.$expand[]stringEach item

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Get calendar Group — response body

Referenced models: Get calendar Group — response body

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

Get calendar Group — response body
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get rule — response body — @odata type, id
$ (allOf 2)objectAll variants apply
$ (allOf 2).@odata.typestringOptional
$ (allOf 2).calendarsarrayOptionalThe calendars in the calendar group. Navigation property. Read-only. Nullable.
$ (allOf 2).calendars[]ModelEach itemExpand Get calendar — response body
$ (allOf 2).changeKeyJSONOptional
$ (allOf 2).changeKey (anyOf 1)stringAlternativeIdentifies the version of the calendar group. Every time the calendar group is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.
$ (allOf 2).changeKey (anyOf 2)nullAlternative
$ (allOf 2).classIdJSONOptional
$ (allOf 2).classId (anyOf 1)stringAlternativeThe class identifier. Read-only.
Format: uuid
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
$ (allOf 2).classId (anyOf 2)nullAlternative
$ (allOf 2).nameJSONOptional
$ (allOf 2).name (anyOf 1)stringAlternativeThe group name.
$ (allOf 2).name (anyOf 2)nullAlternative

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

Get calendar Permission — response body
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get rule — response body — @odata type, id
$ (allOf 2)objectAll variants apply
$ (allOf 2).@odata.typestringOptional
$ (allOf 2).allowedRolesarrayOptionalList 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[]JSONEach item
$ (allOf 2).allowedRoles[] (anyOf 1)stringAlternativeKnown values: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom
$ (allOf 2).allowedRoles[] (anyOf 2)JSONAlternative
$ (allOf 2).allowedRoles[] (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).allowedRoles[] (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).emailAddressJSONOptionalRepresents 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)ModelAlternativeExpand 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)JSONAlternative
$ (allOf 2).emailAddress (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).emailAddress (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).isInsideOrganizationJSONOptional
$ (allOf 2).isInsideOrganization (anyOf 1)booleanAlternativeTrue if the user in context (recipient or delegate) is inside the same organization as the calendar owner.
$ (allOf 2).isInsideOrganization (anyOf 2)nullAlternative
$ (allOf 2).isRemovableJSONOptional
$ (allOf 2).isRemovable (anyOf 1)booleanAlternativeTrue 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)nullAlternative
$ (allOf 2).roleJSONOptionalCurrent permission level of the calendar share recipient or delegate.
$ (allOf 2).role (anyOf 1)stringAlternativeKnown values: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom
$ (allOf 2).role (anyOf 2)JSONAlternative
$ (allOf 2).role (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).role (anyOf 2) (anyOf 2)nullAlternative

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
FieldTypePresenceDescription and constraints
$objectRoot
@odata.typestringOptional
addressJSONOptional
address (anyOf 1)stringAlternativeThe email address of the person or entity.
address (anyOf 2)nullAlternative
nameJSONOptional
name (anyOf 1)stringAlternativeThe display name of the person or entity.
name (anyOf 2)nullAlternative
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
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get rule — response body — @odata type, id
$ (allOf 2)objectAll variants apply
$ (allOf 2).@odata.typestringOptional
$ (allOf 2).valuearrayOptionalA collection of property values.
$ (allOf 2).value[]JSONEach item
$ (allOf 2).value[] (anyOf 1)stringAlternative
$ (allOf 2).value[] (anyOf 2)nullAlternative

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

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 single Value Extended Properties item
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get rule — response body — @odata type, id
$ (allOf 2)objectAll variants apply
$ (allOf 2).@odata.typestringOptional
$ (allOf 2).valueJSONOptional
$ (allOf 2).value (anyOf 1)stringAlternativeA property value.
$ (allOf 2).value (anyOf 2)nullAlternative

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

Get attachment — response body
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get rule — response body — @odata type, id
$ (allOf 2)objectAll variants applydiscriminator: {"mapping": {}, "propertyName": "@odata.type"}
$ (allOf 2).@odata.typestringOptional
$ (allOf 2).contentTypeJSONOptional
$ (allOf 2).contentType (anyOf 1)stringAlternativeThe MIME type.
$ (allOf 2).contentType (anyOf 2)nullAlternative
$ (allOf 2).isInlinebooleanOptionaltrue if the attachment is an inline attachment; otherwise, false.
$ (allOf 2).lastModifiedDateTimeJSONOptional
$ (allOf 2).lastModifiedDateTime (anyOf 1)stringAlternativeThe 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)nullAlternative
$ (allOf 2).nameJSONOptional
$ (allOf 2).name (anyOf 1)stringAlternativeThe attachment's file name.
$ (allOf 2).name (anyOf 2)nullAlternative
$ (allOf 2).sizeJSONOptional
$ (allOf 2).size (anyOf 1)numberAlternativeThe length of the attachment in bytes.
Format: int32
Maximum: 2147483647
Minimum: -2147483648
$ (allOf 2).size (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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

SDK function policy ID: microsoft.me_getcalendargroups. Catalog operation: me_getcalendargroups. 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"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.