MS Teams – Team – Get Teams

Estimated reading: 5 minutes

MS Teams – Team – Get Teams

Get the list of teams a user is a member of.

Action details

PropertyValue
Action labelMS Teams – Team – Get Teams
CategoryCloudTools
Apex class and methodGetMSTeamsTeams.getTeams
Input typeGetMSTeamsTeams.GetMSTeamsTeamsInput
Output typeList<List<MSTeamsTeam>>
AuthorizationMicrosoft 365 connector; check endpoint support for delegated and application access.
Microsoft Graph requestGET /users/{userId}/joinedTeams

Prerequisites and permissions

Configure a CloudTools Connector with Connector Type set to Microsoft 365. Complete Microsoft sign-in for OAuth Delegated (Authorization Code). For endpoints supporting OAuth Application (Client Credentials), grant application permissions and administrator consent. The identity must have access to the selected resource. See Creating an Entra ID App and Integration Connectors for setup.

The action permission provider declares these alternatives. They are not cumulative requirements, and not all are least privileged. Confirm endpoint restrictions and any resource-specific consent requirements in the Microsoft reference.

Permission typeDeclared alternatives
DelegatedTeam.ReadBasic.All, AgentIdUser.ReadWrite.All, AgentIdUser.ReadWrite.IdentityParentedBy, Directory.Read.All, Directory.ReadWrite.All, TeamSettings.Read.All, TeamSettings.ReadWrite.All, User.Read.All, User.ReadWrite.All
ApplicationTeam.ReadBasic.All, TeamSettings.Read.All, TeamSettings.ReadWrite.All

Endpoints: /users/{userId}/joinedTeams. Group and Directory permissions are listed for backward compatibility.

See the Microsoft operation and permissions reference.

Inputs

InputApex fieldTypeRequiredDescription
User IduserIdStringYesMicrosoft user identifier or UPN

Supply a nonempty list with a non-null first request. This implementation processes only the first request and does not bulk-process Flow interviews. Global inputs do not expose connectorId; Flow and subscriber Apex use CloudTools connector selection. Use Microsoft Graph IDs, not Salesforce IDs or browser links. Resolve dynamic values before invoking this action.

Outputs

Returns an outer list containing one collection of MSTeamsTeam items. A missing or unmappable collection produces an empty inner list. The outer list does not correspond to every input request.

OutputApex fieldTypeDescription
IdidStringUnique identifier of the team
Display NamedisplayNameStringDisplay name of the team
DescriptiondescriptionStringDescription of the team
Created Date TimecreatedDateTimeStringCreated timestamp for the team
Internal IdinternalIdStringInternal identifier for the team
ClassificationclassificationStringClassification label for the team
SpecializationspecializationStringSpecialization for the team
VisibilityvisibilityStringVisibility of the team
Web URLwebUrlStringLink to the team in Teams
Is ArchivedisArchivedBooleanWhether the team is archived
Tenant IdtenantIdStringTenant identifier for the team
OData TypeodataTypeStringOData type for the team
Additional PropertiesadditionalPropertiesList<DynamicObject>Additional properties from user-defined query

Behavior and limits

Only the returned value collection is mapped; this action does not follow or expose @odata.nextLink. A result may contain only the first page.

Use in Flow

Add MS Teams – Team – Get Teams where supported. Use a Microsoft 365 application connector configured as Set as default for Flow automations only if the endpoint supports the required application operation. Delegated connections are not supported for CloudTools Flow automation. Supply required values, retain outputs, and add fault handling.

Use in custom Apex

This subscriber-org example uses the Apptigent namespace. Replace example identifiers and values before use. Configure the connector, arrange authorization first, run in a context permitting callouts, and handle exceptions and empty results.

Apptigent.GetMSTeamsTeams.GetMSTeamsTeamsInput request =
    new Apptigent.GetMSTeamsTeams.GetMSTeamsTeamsInput();
request.userId = 'd7b45f12-8a16-4a1f-95f1-dfde7f2af91b';

List<List<Apptigent.MSTeamsTeam>> results =
    Apptigent.GetMSTeamsTeams.getTeams(
        new List<Apptigent.GetMSTeamsTeams.GetMSTeamsTeamsInput>{ request }
    );
System.debug(results);

Use in a Lightning Web Component

Use getMSTeamsTeams from msTeamsConnectorLib through MSTeamsConnectorController. Set request.connectorId to select a configured connector. These c/ imports apply in the same namespace. The controller uses a shared request DTO; its field names differ from the global invocable input.

Global inputLWC request mapping
userIdrequest.userId

teamsActionExample.js

import { LightningElement } from 'lwc';
import { getMSTeamsTeams } from 'c/msTeamsConnectorLib';

export default class TeamsActionExample extends LightningElement {
    result = null;
    errorMessage = '';
    isRunning = false;
    completed = false;

    async handleRun() {
        if (this.isRunning || this.completed) return;
        this.isRunning = true;
        this.errorMessage = '';
        try {
            const request = { connectorId: 'REPLACE_WITH_CONNECTOR_RECORD_ID' };
            request.userId = 'd7b45f12-8a16-4a1f-95f1-dfde7f2af91b';
            this.result = await getMSTeamsTeams(request);
            this.completed = true;
        } catch (error) {
            this.errorMessage = error.requiresInteractiveAuthorization
                ? 'Sign in to Microsoft for the connector, then try again.'
                : error.message || 'The Teams action failed.';
        } finally {
            this.isRunning = false;
        }
    }
}

teamsActionExample.html

<template>
    <lightning-button label="Run action" onclick={handleRun}
        disabled={isRunning}></lightning-button>
    <p role="alert">{errorMessage}</p>
</template>

The library resolves to an array of mapped objects. rawJson serializes the mapped Apex model rather than the untouched Microsoft response. Message body, membership roles, and nested properties can be flattened or serialized in JavaScript DTOs.

Use getMSTeamsAuthorizationState, beginMSTeamsAuthorization, and createMSTeamsOAuthMessageHandler to arrange delegated sign-in. The library normalizes errors but does not automatically sign in or retry. Reset completed for a new deliberate operation. Inspect resource state before retrying a mutation with an uncertain outcome.

Error handling and troubleshooting

SymptomWhat to check
Required fields errorSupply a nonempty request list, a non-null first request, and required or conditionally required values. For LWC, check controller mappings.
Authorization or access deniedCheck selected connector, delegated versus application support, consent, Teams app installation where required, and access to the resource.
Resource not foundCheck team, channel, chat, message, membership, and app installation IDs; these are distinct identifiers.
Missing dataCheck pagination, query support, empty-response behavior, and documented model mapping.
Operation rejectedInspect the Microsoft error, endpoint restrictions, supported properties, message authorization limits, and notification configuration.

See Teams connector introduction.

Share this Doc

MS Teams – Team – Get Teams

Or copy link

CONTENTS

Free eBook: The Ultimate Guide to Power Platform Custom Connectors

Antimanual

Ask our AI support assistant your questions about our platform, features, and services.

You are offline
Chatbot avatar
What can I help you with?

Subscribe

×
Cancel