Microsoft

Microsoft Graph: Teams, channels and apps

Create and manage teams and channels, post and read channel messages, manage members, tabs and installed apps, and work with team templates and the Teams app…

Communication#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Create and manage teams and channels, post and read channel messages, manage members, tabs and installed apps, and work with team templates and the Teams app catalog.

This listing is one area of Microsoft Graph, the single REST API for Microsoft 365, Outlook, OneDrive, Teams and Microsoft Entra ID. It holds 366 of the area's requests, the most direct ones first, generated from Microsoft's own OpenAPI description of Graph v1.0. The other areas (mail, calendar, files, Teams, users and more) are listed separately on the Microsoft page.

Get an access token

  1. Sign in to the Microsoft Entra admin center and open App registrations > New registration. For a quick test, the Graph Explorer signs you in and shows a token without registering anything.
  2. Under API permissions, add the Microsoft Graph permissions this area needs, for example: Team.ReadBasic.All, Channel.ReadBasic.All, ChannelMessage.Send, TeamMember.ReadWrite.All. Delegated permissions act as the signed-in user; application permissions act as the app itself and need an administrator's consent.
  3. Under Certificates & secrets, create a client secret (keep it out of shared collections).
  4. Get a token from https://login.microsoftonline.com/ /oauth2/v2.0/token: the authorization-code flow for a user, or grant_type=client_credentials with scope=https://graph.microsoft.com/.default for an app. Send it as Authorization: Bearer .

Using these requests

  • Base URL: https://graph.microsoft.com/v1.0. /me/... paths act on the signed-in user; with an application token use /users/{id or userPrincipalName}/... instead.
  • Shape responses with OData query parameters: $select (fields), $filter, $orderby, $top, $expand and $search (some need the ConsistencyLevel: eventual header). Long lists are paged: follow @odata.nextLink.
  • Combine up to 20 requests in one call with POST /$batch.

Common errors

StatusCodeWhat to do
401InvalidAuthenticationTokenThe token is missing, expired or for another resource: get a new one for https://graph.microsoft.com.
403Authorization_RequestDenied / ErrorAccessDeniedAdd the permission listed in the request's docs and grant consent.
404ResourceNotFound / itemNotFoundCheck the id; ids from another user or tenant are not found.
429TooManyRequestsThrottled: wait the Retry-After seconds, then retry.

Docs: Teams, channels and apps overview · Permissions reference · Throttling

Endpoints 366

Teams

  • GETList teams/teamsList all teams in an organization.
  • POSTCreate team/teamsCreate a new team.
  • GETGet all messages (team)/teams/getAllMessages()
  • GETGet team/teams/:team-idRetrieve the properties and relationships of the specified team.
  • DELETEDelete team/teams/:team-id
  • PATCHUpdate team/teams/:team-idUpdate the properties of the specified team.
  • POSTClone team/teams/:team-id/cloneCreate a copy of a team. This operation also creates a copy of the corresponding group. You can specify which parts of the team to clone: When tabs are…
  • GETGet group/teams/:team-id/group
  • POSTArchive team/teams/:team-id/archiveArchive the specified team. When a team is archived, users can no longer make most changes to the team. For example, users can no longer: send or like…
  • GETGet template/teams/:team-id/templateThe template this team was created from. See available templates.
  • POSTUnarchive team/teams/:team-id/unarchiveRestore an archived team. This API restores users' ability to send messages and edit the team, abiding by tenant and team settings. A Team is archived using…
  • GETList all channels/teams/:team-id/allChannelsGet the list of channels either in this team or shared with this team (incoming channels).
  • GETList incoming channels/teams/:team-id/incomingChannelsGet the list of incoming channels (channels shared with a team).
  • POSTComplete migration (team)/teams/:team-id/completeMigrationComplete the message migration process by removing migration mode from a team. Migration mode is a special state where certain operations are barred, like…
  • POSTSend activity notification (team)/teams/:team-id/sendActivityNotificationSend an activity feed notification in the scope of a team. For more information about sending notifications and the requirements for doing so, see sending…
  • GETGet all channel/teams/:team-id/allChannels/:channel-idList of channels either hosted in or shared with the team (incoming channels).
  • GETGet incoming channel/teams/:team-id/incomingChannels/:channel-idList of channels shared with the team.
  • GETList service provisioning errors/teams/:team-id/group/serviceProvisioningErrorsErrors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a group object. Supports…

Teams: tags

  • GETList tags/teams/:team-id/tagsGet a list of the tag objects and their properties.
  • POSTCreate tag/teams/:team-id/tagsCreate a standard tag for members in a team.
  • GETGet tag/teams/:team-id/tags/:teamworkTag-idRead the properties and relationships of a tag object.
  • DELETEDelete tag/teams/:team-id/tags/:teamworkTag-idDelete a tag object permanently.
  • PATCHUpdate tag/teams/:team-id/tags/:teamworkTag-idUpdate the properties of a tag object.
  • GETList members/teams/:team-id/tags/:teamworkTag-id/membersGet a list of the members of a standard tag in a team and their properties.
  • POSTCreate member/teams/:team-id/tags/:teamworkTag-id/membersCreate a new teamworkTagMember object in a team.
  • GETGet member/teams/:team-id/tags/:teamworkTag-id/members/:teamworkTagMember-idGet the properties and relationships of a member of a standard tag in a team.
  • DELETEDelete member/teams/:team-id/tags/:teamworkTag-id/members/:teamworkTagMember-idDelete a member from a standard tag in a team.
  • PATCHUpdate member/teams/:team-id/tags/:teamworkTag-id/members/:teamworkTagMember-id

Teams: photo

  • GETGet photo/teams/:team-id/photoGet the specified profilePhoto or its metadata (profilePhoto properties). The supported sizes of HD photos on Microsoft 365 are as follows: 48x48, 64x64,…
  • PATCHUpdate photo/teams/:team-id/photoUpdate the photo for the specified contact, group, team, or user in a tenant. The size of the photo you can update to is limited to 4 MB. You can use either…
  • GETDownload team content/teams/:team-id/photo/$valueGet the specified profilePhoto or its metadata (profilePhoto properties). The supported sizes of HD photos on Microsoft 365 are as follows: 48x48, 64x64,…
  • PUTUpload team content/teams/:team-id/photo/$valueUpdate the photo for the specified contact, group, team, or user in a tenant. The size of the photo you can update to is limited to 4 MB. You can use either…
  • DELETEUpload team content/teams/:team-id/photo/$valueThe profile photo for the team.

Teams: members

  • GETList members/teams/:team-id/membersGet the conversationMember collection of a team. The membership IDs returned by the server must be treated as opaque strings. The client shouldn't try to…
  • POSTCreate member/teams/:team-id/membersAdd a new conversationMember to a team.
  • POSTAdd member/teams/:team-id/members/addAdd multiple members in a single request to a team. The response provides details about which memberships could and couldn't be created.
  • POSTRemove member/teams/:team-id/members/removeRemove multiple members from a team in a single request. The response provides details about which memberships could and couldn't be removed.
  • GETGet member/teams/:team-id/members/:conversationMember-idGet a conversationMember from a team.
  • DELETEDelete member/teams/:team-id/members/:conversationMember-idRemove a conversationMember from a team.
  • PATCHUpdate member/teams/:team-id/members/:conversationMember-idUpdate the role of a conversationMember in a team.

Teams: channels

  • GETList channels/teams/:team-id/channelsRetrieve the list of channels in this team.
  • POSTCreate channel/teams/:team-id/channelsCreate a new channel in a team, as specified in the request body. When you create a channel, the maximum length of the channel's displayName is 50 characters.…
  • GETGet channel/teams/:team-id/channels/:channel-idRetrieve the properties and relationships of a channel. This method supports federation. Only a user who is a member of the shared channel can retrieve…
  • DELETEDelete channel/teams/:team-id/channels/:channel-idDelete the channel.
  • PATCHUpdate channel/teams/:team-id/channels/:channel-idUpdate the properties of the specified channel.
  • GETGet all messages (channel)/teams/:team-id/channels/getAllMessages()Retrieve messages across all channels in a team, including text, audio, and video conversations. To learn more about how to use the Microsoft Teams export…
  • GETGet all retained messages (channel)/teams/:team-id/channels/getAllRetainedMessages()Get all retained messages across all channels in a team. To learn more about how to use the Microsoft Teams export APIs to export content, see Export content…
  • GETList tabs/teams/:team-id/channels/:channel-id/tabsRetrieve the list of tabs in the specified channel within a team.
  • POSTCreate tab/teams/:team-id/channels/:channel-id/tabsAdd (pin) a tab to the specified channel within a team. The app must be preinstalled in the team and have the configurableTabs property defined in the app…
  • POSTArchive channel/teams/:team-id/channels/:channel-id/archiveArchive a channel in a team. When a channel is archived, users can't send new messages or react to existing messages in the channel, edit the channel…
  • GETList members/teams/:team-id/channels/:channel-id/membersGet a list of members in a channel, including direct members of standard, private, and shared channels. Use the List allMembers API to retrieve both direct…
  • POSTCreate member/teams/:team-id/channels/:channel-id/membersAdd a conversationMember to a channel. This operation is allowed only for channels with a membershipType value of private or shared.
  • GETList messages/teams/:team-id/channels/:channel-id/messagesRetrieve the list of messages (without the replies) in a channel of a team. To get the replies for a message, call the list message replies or the get message…
  • POSTCreate message/teams/:team-id/channels/:channel-id/messagesSend a new chatMessage in the specified channel.
  • POSTUnarchive channel/teams/:team-id/channels/:channel-id/unarchiveRestore an archived channel. Unarchiving restores the ability for users to send messages and edit the channel. Channels are archived via the channel: archive…
  • GETList all members/teams/:team-id/channels/:channel-id/allMembersGet a list of all members in a channel. This API supports all channel types, including shared channels. For shared channels, the response includes:
  • POSTCreate all member/teams/:team-id/channels/:channel-id/allMembers
  • GETList enabled apps/teams/:team-id/channels/:channel-id/enabledAppsGet a list of the enabled apps in the specified channel within a team.
  • GETGet files folder/teams/:team-id/channels/:channel-id/filesFolderGet the metadata for the location where the files of a channel are stored.
  • POSTRemove email (channel)/teams/:team-id/channels/:channel-id/removeEmailRemove the email address of a channel. You can remove an email address only if it was provisioned using the provisionEmail method or through the Microsoft…
  • POSTProvision email (channel)/teams/:team-id/channels/:channel-id/provisionEmailProvision an email address for a channel. Microsoft Teams doesn't automatically provision an email address for a channel by default. To have Teams provision…
  • POSTStart migration (channel)/teams/:team-id/channels/:channel-id/startMigrationStart the migration of external messages by enabling migration mode in an existing channel. Import operations were limited to newly created standard channels…
  • GETList shared with teams/teams/:team-id/channels/:channel-id/sharedWithTeamsGet the list of teams that has been shared a specified channel. This operation is allowed only for channels with a membershipType value of shared.
  • POSTCreate shared with team/teams/:team-id/channels/:channel-id/sharedWithTeams
  • POSTComplete migration (channel)/teams/:team-id/channels/:channel-id/completeMigrationComplete migration on existing channels or new channels. Complete migration operations were initially restricted to newly created standard channels using…
  • GETDoes user have access (channel)/teams/:team-id/channels/:channel-id/doesUserHaveAccess(userId='@userId',tenantId='@tenantId',userPrincipalName='@userPrincipalName')Determine whether a user has access to a channel.
  • POSTAdd member/teams/:team-id/channels/:channel-id/members/addAdd multiple members in a single request to a team. The response provides details about which memberships could and couldn't be created.
  • POSTAdd all member/teams/:team-id/channels/:channel-id/allMembers/addAdd multiple members in a single request to a team. The response provides details about which memberships could and couldn't be created.
  • POSTRemove member/teams/:team-id/channels/:channel-id/members/removeRemove multiple members from a team in a single request. The response provides details about which memberships could and couldn't be removed.
  • GETTrack changes to messages (delta)/teams/:team-id/channels/:channel-id/messages/delta()Get the list of messages from all chats in which a user is a participant, including one-on-one chats, group chats, and meeting chats. When you use delta…
  • POSTRemove all member/teams/:team-id/channels/:channel-id/allMembers/removeRemove multiple members from a team in a single request. The response provides details about which memberships could and couldn't be removed.
  • GETGet tab/teams/:team-id/channels/:channel-id/tabs/:teamsTab-idRetrieve the properties and relationships of the specified tab in a channel within a team.
  • DELETEDelete tab/teams/:team-id/channels/:channel-id/tabs/:teamsTab-idRemoves (unpins) a tab from the specified channel within a team.
  • PATCHUpdate tab/teams/:team-id/channels/:channel-id/tabs/:teamsTab-idUpdate the properties of the specified tab. This API can be used to configure the content of the tab.
  • GETDownload files folder content/teams/:team-id/channels/:channel-id/filesFolder/contentThe content stream, if the item represents a file.
  • PUTUpload files folder content/teams/:team-id/channels/:channel-id/filesFolder/contentThe content stream, if the item represents a file.
  • DELETEUpload files folder content/teams/:team-id/channels/:channel-id/filesFolder/contentThe content stream, if the item represents a file.
  • POSTReply with quote (message)/teams/:team-id/channels/:channel-id/messages/replyWithQuoteReply with quote to a single chat message or multiple chat messages in a chat.
  • GETGet enabled app/teams/:team-id/channels/:channel-id/enabledApps/:teamsApp-idGet an enabled app in the specified channel within a team.
  • GETGet message/teams/:team-id/channels/:channel-id/messages/:chatMessage-idRetrieve a single message or a message reply in a channel or a chat.
  • DELETEDelete message/teams/:team-id/channels/:channel-id/messages/:chatMessage-id
  • PATCHUpdate message/teams/:team-id/channels/:channel-id/messages/:chatMessage-idUpdate a chatMessage object. Except for the policyViolation property, all properties of a chatMessage can be updated in delegated permissions scenarios. Only…
  • GETGet member/teams/:team-id/channels/:channel-id/members/:conversationMember-idGet a conversationMember from a channel.
  • DELETEDelete member/teams/:team-id/channels/:channel-id/members/:conversationMember-idDelete a conversationMember from a channel. This operation is allowed only for channels with a membershipType value of private or shared.
  • PATCHUpdate member/teams/:team-id/channels/:channel-id/members/:conversationMember-idUpdate the role of a conversationMember in a channel. This operation is allowed only for channels with a membershipType value of private or shared.
  • GETGet all member/teams/:team-id/channels/:channel-id/allMembers/:conversationMember-idA collection of membership records associated with the channel, including both direct and indirect members of shared channels.
  • DELETEDelete all member/teams/:team-id/channels/:channel-id/allMembers/:conversationMember-id
  • PATCHUpdate all member/teams/:team-id/channels/:channel-id/allMembers/:conversationMember-id
  • GETGet shared with team/teams/:team-id/channels/:channel-id/sharedWithTeams/:sharedWithChannelTeamInfo-idGet a team that has been shared with a specified channel. This operation is allowed only for channels with a membershipType value of shared.
  • DELETEDelete shared with team/teams/:team-id/channels/:channel-id/sharedWithTeams/:sharedWithChannelTeamInfo-idUnshare a channel with a team by deleting the corresponding sharedWithChannelTeamInfo resource. This operation is allowed only for channels with a…
  • PATCHUpdate shared with team/teams/:team-id/channels/:channel-id/sharedWithTeams/:sharedWithChannelTeamInfo-id
  • GETGet teams app/teams/:team-id/channels/:channel-id/tabs/:teamsTab-id/teamsAppThe application that is linked to the tab. This can't be changed after tab creation.
  • GETList replies/teams/:team-id/channels/:channel-id/messages/:chatMessage-id/repliesList all the replies to a message in a channel of a team. This method lists only the replies of the specified message, if any. To get the message itself, call…
  • POSTCreate reply/teams/:team-id/channels/:channel-id/messages/:chatMessage-id/repliesCreate a new reply to a chatMessage in a specified channel.
  • POSTCreate soft delete/teams/:team-id/channels/:channel-id/messages/:chatMessage-id/softDeleteDelete a single chatMessage or a chat message reply in a channel or a chat.
  • POSTSet reaction (message)/teams/:team-id/channels/:channel-id/messages/:chatMessage-id/setReaction
  • POSTCreate unset reaction/teams/:team-id/channels/:channel-id/messages/:chatMessage-id/unsetReaction
  • GETList hosted contents/teams/:team-id/channels/:channel-id/messages/:chatMessage-id/hostedContentsRetrieve the list of chatMessageHostedContent objects from a message. This API only lists the hosted content objects. To get the content bytes, see get…
  • POSTCreate hosted content/teams/:team-id/channels/:channel-id/messages/:chatMessage-id/hostedContents
  • POSTCreate undo soft delete/teams/:team-id/channels/:channel-id/messages/:chatMessage-id/undoSoftDeleteUndo soft deletion of a single chatMessage or a chat message reply in a channel or a chat.
  • GETGet team/teams/:team-id/channels/:channel-id/sharedWithTeams/:sharedWithChannelTeamInfo-id/team
  • GETList allowed members/teams/:team-id/channels/:channel-id/sharedWithTeams/:sharedWithChannelTeamInfo-id/allowedMembersGet the list of conversationMembers who can access a shared channel. This method doesn't return the following conversationMembers from the team: Users with…

Teams: schedule

  • GETGet schedule/teams/:team-id/scheduleRetrieve the properties and relationships of a schedule object. The schedule creation process conforms to the One API guideline for resource based long…
  • PUTReplace schedule/teams/:team-id/scheduleCreate or replace a schedule object. The schedule creation process conforms to the One API guideline for resource based long running operations (RELO). When…
  • DELETEDelete schedule/teams/:team-id/schedule
  • POSTCreate share/teams/:team-id/schedule/shareShare a schedule time range with schedule members. This action makes the collections of shift, openshift and timeOff items in the specified time range of the…
  • GETList shifts/teams/:team-id/schedule/shiftsGet the list of shift instances in a schedule.
  • POSTCreate shift/teams/:team-id/schedule/shiftsCreate a new shift instance in a schedule. The duration of a shift cannot be less than 1 minute or longer than 24 hours.
  • GETList day notes/teams/:team-id/schedule/dayNotesThe day notes in the schedule.
  • POSTCreate day note/teams/:team-id/schedule/dayNotes
  • GETGet times off/teams/:team-id/schedule/timesOffGet the list of timeOff instances in a schedule.
  • POSTCreate times off/teams/:team-id/schedule/timesOffCreate a new timeOff instance in a schedule.
  • GETList time cards/teams/:team-id/schedule/timeCardsRetrieve a list of timeCard entries in a schedule.
  • POSTCreate time card/teams/:team-id/schedule/timeCardsCreate a timeCard instance in a schedule.
  • GETList open shifts/teams/:team-id/schedule/openShiftsList openShift objects in a team.
  • POSTCreate open shift/teams/:team-id/schedule/openShiftsCreate an instance of an openShift object.
  • GETList time off reasons/teams/:team-id/schedule/timeOffReasonsGet the list of timeOffReasons in a schedule.
  • POSTCreate time off reason/teams/:team-id/schedule/timeOffReasonsCreate a new timeOffReason.
  • GETList time off requests/teams/:team-id/schedule/timeOffRequestsRetrieve a list of timeOffRequest objects in the team.
  • POSTCreate time off request/teams/:team-id/schedule/timeOffRequestsCreate instance of a timeoffrequest object.
  • GETList scheduling groups/teams/:team-id/schedule/schedulingGroupsGet the list of schedulingGroups in this schedule.
  • POSTCreate scheduling group/teams/:team-id/schedule/schedulingGroupsCreate a new schedulingGroup.
  • GETList offer shift requests/teams/:team-id/schedule/offerShiftRequestsRetrieve the properties and relationships of all offerShiftRequest objects in a team.
  • POSTCreate offer shift request/teams/:team-id/schedule/offerShiftRequestsCreate an instance of an offerShiftRequest.
  • GETList open shift change requests/teams/:team-id/schedule/openShiftChangeRequestsRetrieve a list of openShiftChangeRequest objects in a team.
  • POSTCreate open shift change request/teams/:team-id/schedule/openShiftChangeRequestsCreate instance of an openShiftChangeRequest object.
  • GETList swap shifts change requests/teams/:team-id/schedule/swapShiftsChangeRequestsRetrieve a list of swapShiftsChangeRequest objects in the team.
  • POSTCreate swap shifts change request/teams/:team-id/schedule/swapShiftsChangeRequestsCreate an instance of a swapShiftsChangeRequest object.
  • GETGet shift/teams/:team-id/schedule/shifts/:shift-idRetrieve the properties and relationships of a shift object by ID.
  • DELETEDelete shift/teams/:team-id/schedule/shifts/:shift-idDelete a shift from the schedule.
  • PATCHUpdate shift/teams/:team-id/schedule/shifts/:shift-idReplace an existing shift. If the specified shift doesn't exist, this method returns 404 Not found. The duration of a shift can't be less than one minute or…
  • POSTCreate clock in/teams/:team-id/schedule/timeCards/clockInClock in to start a timeCard.
  • GETGet day note/teams/:team-id/schedule/dayNotes/:dayNote-idThe day notes in the schedule.
  • DELETEDelete day note/teams/:team-id/schedule/dayNotes/:dayNote-id
  • PATCHUpdate day note/teams/:team-id/schedule/dayNotes/:dayNote-id
  • GETGet times off/teams/:team-id/schedule/timesOff/:timeOff-idRetrieve the properties and relationships of a timeOff object by ID.
  • DELETEDelete times off/teams/:team-id/schedule/timesOff/:timeOff-idDelete a timeOff instance from a schedule.
  • PATCHUpdate times off/teams/:team-id/schedule/timesOff/:timeOff-idReplace an existing timeOff object. If the specified timeOff object doesn't exist, this method returns 404 Not found.
  • GETGet time card/teams/:team-id/schedule/timeCards/:timeCard-idThe time cards in the schedule.
  • DELETEDelete time card/teams/:team-id/schedule/timeCards/:timeCard-idDelete a timeCard instance in a schedule.
  • PATCHUpdate time card/teams/:team-id/schedule/timeCards/:timeCard-id
  • GETGet open shift/teams/:team-id/schedule/openShifts/:openShift-idRetrieve the properties and relationships of an openshift object.
  • DELETEDelete open shift/teams/:team-id/schedule/openShifts/:openShift-idDelete an openShift object.
  • PATCHUpdate open shift/teams/:team-id/schedule/openShifts/:openShift-idUpdate the properties of an openShift object.
  • GETGet time off reason/teams/:team-id/schedule/timeOffReasons/:timeOffReason-idRetrieve the properties and relationships of a timeOffReason object by ID.
  • DELETEDelete time off reason/teams/:team-id/schedule/timeOffReasons/:timeOffReason-idMark a timeOffReason as inactive by setting the isActive property. Every team must include at least one timeoff reason. This method doesn't remove the…
  • PATCHUpdate time off reason/teams/:team-id/schedule/timeOffReasons/:timeOffReason-idReplace an existing timeOffReason. If the specified timeOffReason doesn't exist, this method returns 404 Not found.
  • GETGet time off request/teams/:team-id/schedule/timeOffRequests/:timeOffRequest-idRetrieve the properties and relationships of a timeoffrequest object.
  • DELETEDelete time off request/teams/:team-id/schedule/timeOffRequests/:timeOffRequest-idDelete a timeOffRequest object.
  • PATCHUpdate time off request/teams/:team-id/schedule/timeOffRequests/:timeOffRequest-id
  • GETGet scheduling group/teams/:team-id/schedule/schedulingGroups/:schedulingGroup-idRetrieve the properties and relationships of a schedulingGroup by ID.
  • DELETEDelete scheduling group/teams/:team-id/schedule/schedulingGroups/:schedulingGroup-idMark a schedulingGroup as inactive by setting its isActive property. This method doesn't remove the schedulingGroup from the schedule. Existing shift…
  • PATCHUpdate scheduling group/teams/:team-id/schedule/schedulingGroups/:schedulingGroup-idReplace an existing schedulingGroup. If the specified schedulingGroup doesn't exist, this method returns 404 Not found.
  • GETGet offer shift request/teams/:team-id/schedule/offerShiftRequests/:offerShiftRequest-idRetrieve the properties and relationships of an offerShiftRequest object.
  • DELETEDelete offer shift request/teams/:team-id/schedule/offerShiftRequests/:offerShiftRequest-id
  • PATCHUpdate offer shift request/teams/:team-id/schedule/offerShiftRequests/:offerShiftRequest-id
  • GETGet open shift change request/teams/:team-id/schedule/openShiftChangeRequests/:openShiftChangeRequest-idRetrieve the properties and relationships of an openShiftChangeRequest object.
  • DELETEDelete open shift change request/teams/:team-id/schedule/openShiftChangeRequests/:openShiftChangeRequest-id
  • PATCHUpdate open shift change request/teams/:team-id/schedule/openShiftChangeRequests/:openShiftChangeRequest-id
  • GETGet swap shifts change request/teams/:team-id/schedule/swapShiftsChangeRequests/:swapShiftsChangeRequest-idRetrieve the properties and relationships of a swapShiftsChangeRequest object.
  • DELETEDelete swap shifts change request/teams/:team-id/schedule/swapShiftsChangeRequests/:swapShiftsChangeRequest-id
  • PATCHUpdate swap shifts change request/teams/:team-id/schedule/swapShiftsChangeRequests/:swapShiftsChangeRequest-id
  • POSTCreate confirm/teams/:team-id/schedule/timeCards/:timeCard-id/confirmConfirm a timeCard.
  • POSTCreate clock out/teams/:team-id/schedule/timeCards/:timeCard-id/clockOut
  • POSTCreate end break/teams/:team-id/schedule/timeCards/:timeCard-id/endBreak
  • POSTStart break (time card)/teams/:team-id/schedule/timeCards/:timeCard-id/startBreak

Teams: operations

  • GETList operations/teams/:team-id/operationsThe async operations that ran or are running on this team.
  • POSTCreate operation/teams/:team-id/operations
  • GETGet operation/teams/:team-id/operations/:teamsAsyncOperation-idThe async operations that ran or are running on this team.
  • DELETEDelete operation/teams/:team-id/operations/:teamsAsyncOperation-id
  • PATCHUpdate operation/teams/:team-id/operations/:teamsAsyncOperation-id

Teams: installed apps

  • GETList installed apps/teams/:team-id/installedAppsRetrieve a list of apps installed in the specified team.
  • POSTCreate installed app/teams/:team-id/installedAppsInstall an app to the specified team.
  • GETGet installed app/teams/:team-id/installedApps/:teamsAppInstallation-idRetrieve the app installed in the specified team.
  • DELETEDelete installed app/teams/:team-id/installedApps/:teamsAppInstallation-idUninstalls an app from the specified team.
  • PATCHUpdate installed app/teams/:team-id/installedApps/:teamsAppInstallation-id
  • POSTUpgrade installed app/teams/:team-id/installedApps/:teamsAppInstallation-id/upgradeUpgrade an app installation within a chat.
  • GETGet teams app/teams/:team-id/installedApps/:teamsAppInstallation-id/teamsAppThe app that is installed.
  • GETGet teams app definition/teams/:team-id/installedApps/:teamsAppInstallation-id/teamsAppDefinitionThe details of this version of the app.

Teams: primary channel

  • GETGet primary channel/teams/:team-id/primaryChannelGet the default channel, General, of a team.
  • DELETEDelete primary channel/teams/:team-id/primaryChannel
  • PATCHUpdate primary channel/teams/:team-id/primaryChannel
  • GETList tabs/teams/:team-id/primaryChannel/tabsA collection of all the tabs in the channel. A navigation property.
  • POSTCreate tab/teams/:team-id/primaryChannel/tabs
  • POSTArchive primary channel/teams/:team-id/primaryChannel/archiveArchive a channel in a team. When a channel is archived, users can't send new messages or react to existing messages in the channel, edit the channel…
  • GETList members/teams/:team-id/primaryChannel/membersA collection of membership records associated with the channel.
  • POSTCreate member/teams/:team-id/primaryChannel/members
  • GETList messages/teams/:team-id/primaryChannel/messagesA collection of all the messages in the channel. A navigation property. Nullable.
  • POSTCreate message/teams/:team-id/primaryChannel/messages
  • POSTUnarchive primary channel/teams/:team-id/primaryChannel/unarchiveRestore an archived channel. Unarchiving restores the ability for users to send messages and edit the channel. Channels are archived via the channel: archive…
  • GETList all members/teams/:team-id/primaryChannel/allMembersA collection of membership records associated with the channel, including both direct and indirect members of shared channels.
  • POSTCreate all member/teams/:team-id/primaryChannel/allMembers
  • GETList enabled apps/teams/:team-id/primaryChannel/enabledAppsA collection of enabled apps in the channel.
  • GETGet files folder/teams/:team-id/primaryChannel/filesFolderMetadata for the location where the channel's files are stored.
  • POSTRemove email (primary channel)/teams/:team-id/primaryChannel/removeEmailRemove the email address of a channel. You can remove an email address only if it was provisioned using the provisionEmail method or through the Microsoft…
  • POSTProvision email (primary channel)/teams/:team-id/primaryChannel/provisionEmailProvision an email address for a channel. Microsoft Teams doesn't automatically provision an email address for a channel by default. To have Teams provision…
  • POSTStart migration (primary channel)/teams/:team-id/primaryChannel/startMigrationStart the migration of external messages by enabling migration mode in an existing channel. Import operations were limited to newly created standard channels…
  • GETList shared with teams/teams/:team-id/primaryChannel/sharedWithTeamsA collection of teams with which a channel is shared.
  • POSTCreate shared with team/teams/:team-id/primaryChannel/sharedWithTeams
  • POSTComplete migration (primary channel)/teams/:team-id/primaryChannel/completeMigrationComplete migration on existing channels or new channels. Complete migration operations were initially restricted to newly created standard channels using…
  • GETDoes user have access (primary channel)/teams/:team-id/primaryChannel/doesUserHaveAccess(userId='@userId',tenantId='@tenantId',userPrincipalName='@userPrincipalName')Determine whether a user has access to a channel.
  • POSTAdd member/teams/:team-id/primaryChannel/members/addAdd multiple members in a single request to a team. The response provides details about which memberships could and couldn't be created.
  • POSTAdd all member/teams/:team-id/primaryChannel/allMembers/addAdd multiple members in a single request to a team. The response provides details about which memberships could and couldn't be created.
  • POSTRemove member/teams/:team-id/primaryChannel/members/removeRemove multiple members from a team in a single request. The response provides details about which memberships could and couldn't be removed.
  • GETTrack changes to messages (delta)/teams/:team-id/primaryChannel/messages/delta()Get the list of messages from all chats in which a user is a participant, including one-on-one chats, group chats, and meeting chats. When you use delta…
  • POSTRemove all member/teams/:team-id/primaryChannel/allMembers/removeRemove multiple members from a team in a single request. The response provides details about which memberships could and couldn't be removed.
  • GETGet tab/teams/:team-id/primaryChannel/tabs/:teamsTab-idA collection of all the tabs in the channel. A navigation property.
  • DELETEDelete tab/teams/:team-id/primaryChannel/tabs/:teamsTab-id
  • PATCHUpdate tab/teams/:team-id/primaryChannel/tabs/:teamsTab-id
  • GETDownload files folder content/teams/:team-id/primaryChannel/filesFolder/contentThe content stream, if the item represents a file.
  • PUTUpload files folder content/teams/:team-id/primaryChannel/filesFolder/contentThe content stream, if the item represents a file.
  • DELETEUpload files folder content/teams/:team-id/primaryChannel/filesFolder/contentThe content stream, if the item represents a file.
  • POSTReply with quote (message)/teams/:team-id/primaryChannel/messages/replyWithQuoteReply with quote to a single chat message or multiple chat messages in a chat.
  • GETGet enabled app/teams/:team-id/primaryChannel/enabledApps/:teamsApp-idA collection of enabled apps in the channel.
  • GETGet message/teams/:team-id/primaryChannel/messages/:chatMessage-idA collection of all the messages in the channel. A navigation property. Nullable.
  • DELETEDelete message/teams/:team-id/primaryChannel/messages/:chatMessage-id
  • PATCHUpdate message/teams/:team-id/primaryChannel/messages/:chatMessage-id
  • GETGet member/teams/:team-id/primaryChannel/members/:conversationMember-idA collection of membership records associated with the channel.
  • DELETEDelete member/teams/:team-id/primaryChannel/members/:conversationMember-id
  • PATCHUpdate member/teams/:team-id/primaryChannel/members/:conversationMember-id
  • GETGet all member/teams/:team-id/primaryChannel/allMembers/:conversationMember-idA collection of membership records associated with the channel, including both direct and indirect members of shared channels.
  • DELETEDelete all member/teams/:team-id/primaryChannel/allMembers/:conversationMember-id
  • PATCHUpdate all member/teams/:team-id/primaryChannel/allMembers/:conversationMember-id
  • GETGet shared with team/teams/:team-id/primaryChannel/sharedWithTeams/:sharedWithChannelTeamInfo-idA collection of teams with which a channel is shared.
  • DELETEDelete shared with team/teams/:team-id/primaryChannel/sharedWithTeams/:sharedWithChannelTeamInfo-id
  • PATCHUpdate shared with team/teams/:team-id/primaryChannel/sharedWithTeams/:sharedWithChannelTeamInfo-id
  • GETGet teams app/teams/:team-id/primaryChannel/tabs/:teamsTab-id/teamsAppThe application that is linked to the tab. This can't be changed after tab creation.
  • GETList replies/teams/:team-id/primaryChannel/messages/:chatMessage-id/repliesReplies for a specified message. Supports $expand for channel messages.
  • POSTCreate reply/teams/:team-id/primaryChannel/messages/:chatMessage-id/replies
  • POSTCreate soft delete/teams/:team-id/primaryChannel/messages/:chatMessage-id/softDeleteDelete a single chatMessage or a chat message reply in a channel or a chat.
  • POSTSet reaction (message)/teams/:team-id/primaryChannel/messages/:chatMessage-id/setReaction
  • POSTCreate unset reaction/teams/:team-id/primaryChannel/messages/:chatMessage-id/unsetReaction
  • GETList hosted contents/teams/:team-id/primaryChannel/messages/:chatMessage-id/hostedContentsContent in a message hosted by Microsoft Teams - for example, images or code snippets.
  • POSTCreate hosted content/teams/:team-id/primaryChannel/messages/:chatMessage-id/hostedContents
  • POSTCreate undo soft delete/teams/:team-id/primaryChannel/messages/:chatMessage-id/undoSoftDeleteUndo soft deletion of a single chatMessage or a chat message reply in a channel or a chat.
  • GETGet team/teams/:team-id/primaryChannel/sharedWithTeams/:sharedWithChannelTeamInfo-id/team
  • GETList allowed members/teams/:team-id/primaryChannel/sharedWithTeams/:sharedWithChannelTeamInfo-id/allowedMembersA collection of team members who have access to the shared channel.
  • GETTrack changes to replies (delta)/teams/:team-id/primaryChannel/messages/:chatMessage-id/replies/delta()Get the list of messages from all chats in which a user is a participant, including one-on-one chats, group chats, and meeting chats. When you use delta…
  • POSTReply with quote (reply)/teams/:team-id/primaryChannel/messages/:chatMessage-id/replies/replyWithQuoteReply with quote to a single chat message or multiple chat messages in a chat.
  • GETGet reply/teams/:team-id/primaryChannel/messages/:chatMessage-id/replies/:chatMessage-id1Replies for a specified message. Supports $expand for channel messages.
  • DELETEDelete reply/teams/:team-id/primaryChannel/messages/:chatMessage-id/replies/:chatMessage-id1
  • PATCHUpdate reply/teams/:team-id/primaryChannel/messages/:chatMessage-id/replies/:chatMessage-id1
  • GETGet hosted content/teams/:team-id/primaryChannel/messages/:chatMessage-id/hostedContents/:chatMessageHostedContent-idContent in a message hosted by Microsoft Teams - for example, images or code snippets.
  • DELETEDelete hosted content/teams/:team-id/primaryChannel/messages/:chatMessage-id/hostedContents/:chatMessageHostedContent-id
  • PATCHUpdate hosted content/teams/:team-id/primaryChannel/messages/:chatMessage-id/hostedContents/:chatMessageHostedContent-id
  • GETGet allowed member/teams/:team-id/primaryChannel/sharedWithTeams/:sharedWithChannelTeamInfo-id/allowedMembers/:conversationMember-idA collection of team members who have access to the shared channel.

Teams: permission grants

  • GETList permission grants/teams/:team-id/permissionGrantsList all resource-specific permission grants on the team. This list specifies the Microsoft Entra apps that have access to the team, along with each app's…
  • POSTCreate permission grant/teams/:team-id/permissionGrants
  • GETGet permission grant/teams/:team-id/permissionGrants/:resourceSpecificPermissionGrant-idA collection of permissions granted to apps to access the team.
  • DELETEDelete permission grant/teams/:team-id/permissionGrants/:resourceSpecificPermissionGrant-id
  • PATCHUpdate permission grant/teams/:team-id/permissionGrants/:resourceSpecificPermissionGrant-id

Teamwork

  • GETGet teamwork/teamworkGet the properties and relationships of a teamwork object, such as the region of the organization and whether Microsoft Teams is enabled.
  • PATCHUpdate teamwork/teamwork
  • GETGet teamwork/me/teamworkA container for Microsoft Teams features available for the user. Read-only. Nullable.
  • DELETEDelete teamwork/me/teamwork
  • PATCHUpdate teamwork/me/teamwork
  • POSTSend activity notification to recipients (teamwork)/teamwork/sendActivityNotificationToRecipientsSend activity feed notifications to multiple users, in bulk. For more information, see sending Teams activity notifications.
  • POSTCreate delete targeted message/me/teamwork/deleteTargetedMessageDelete a specific targeted message from a channel context. Teams administrators can use this API to remove targeted messages by providing the message ID, team…
  • GETGet all targeted messages (teamwork)/me/teamwork/getAllTargetedMessages()Get all targeted messages sent to a specific user in group chats and channels.
  • POSTSend activity notification (teamwork)/me/teamwork/sendActivityNotificationSend an activity feed notification to a user. For more information, see sending Teams activity notifications.
  • GETGet all retained targeted messages (teamwork)/me/teamwork/getAllRetainedTargetedMessages()Get all retained targeted messages sent to a specific user in group chats and channels.

App catalogs

  • GETList app catalogs/appCatalogs
  • PATCHUpdate app catalogs/appCatalogs

Teams templates

  • GETList teams templates/teamsTemplates
  • POSTCreate teams template/teamsTemplates
  • GETGet teams template/teamsTemplates/:teamsTemplate-id
  • DELETEDelete teams template/teamsTemplates/:teamsTemplate-id
  • PATCHUpdate teams template/teamsTemplates/:teamsTemplate-id

App catalogs: teams apps

  • GETList teams apps/appCatalogs/teamsAppsList apps from the Microsoft Teams app catalog, including apps from the Microsoft Teams store and apps from your organization's app catalog (the tenant app…
  • POSTCreate teams app/appCatalogs/teamsAppsPublish an app to the Microsoft Teams app catalog. Specifically, this API publishes the app to your organization's catalog (the tenant app catalog); the…
  • GETGet teams app/appCatalogs/teamsApps/:teamsApp-id
  • DELETEDelete teams app/appCatalogs/teamsApps/:teamsApp-idDelete an app from an organization's app catalog (the tenant app catalog). To delete an app, the distributionMethod property for the app must be set to…
  • PATCHUpdate teams app/appCatalogs/teamsApps/:teamsApp-id
  • GETList app definitions/appCatalogs/teamsApps/:teamsApp-id/appDefinitionsThe details for each version of the app.
  • POSTCreate app definition/appCatalogs/teamsApps/:teamsApp-id/appDefinitionsUpdate an app previously published to the Microsoft Teams app catalog. To update an app, the distributionMethod property for the app must be set to…
  • GETGet app definition/appCatalogs/teamsApps/:teamsApp-id/appDefinitions/:teamsAppDefinition-idThe details for each version of the app.
  • DELETEDelete app definition/appCatalogs/teamsApps/:teamsApp-id/appDefinitions/:teamsAppDefinition-id
  • PATCHUpdate app definition/appCatalogs/teamsApps/:teamsApp-id/appDefinitions/:teamsAppDefinition-idPublish an app to the Microsoft Teams app catalog. Specifically, this API publishes the app to your organization's catalog (the tenant app catalog); the…
  • GETGet bot/appCatalogs/teamsApps/:teamsApp-id/appDefinitions/:teamsAppDefinition-id/botGet the bot associated with a specific definition of the TeamsApp.
  • DELETEDelete bot/appCatalogs/teamsApps/:teamsApp-id/appDefinitions/:teamsAppDefinition-id/bot
  • PATCHUpdate bot/appCatalogs/teamsApps/:teamsApp-id/appDefinitions/:teamsAppDefinition-id/bot

Teamwork: deleted chats

  • GETList deleted chats/teamwork/deletedChatsRead the properties and relationships of a deletedChat object.
  • POSTCreate deleted chat/teamwork/deletedChats
  • GETGet deleted chat/teamwork/deletedChats/:deletedChat-idRead the properties and relationships of a deletedChat object.
  • DELETEDelete deleted chat/teamwork/deletedChats/:deletedChat-id
  • PATCHUpdate deleted chat/teamwork/deletedChats/:deletedChat-id
  • POSTCreate undo delete/teamwork/deletedChats/:deletedChat-id/undoDeleteRestore a deletedChat to an active chat.

Teamwork: deleted teams

  • GETList deleted teams/teamwork/deletedTeamsGet a list of the deletedTeam objects and their properties.
  • POSTCreate deleted team/teamwork/deletedTeams
  • GETGet all messages (deleted team)/teamwork/deletedTeams/getAllMessages()
  • GETGet deleted team/teamwork/deletedTeams/:deletedTeam-idThe deleted team.
  • DELETEDelete deleted team/teamwork/deletedTeams/:deletedTeam-id
  • PATCHUpdate deleted team/teamwork/deletedTeams/:deletedTeam-id
  • GETList channels/teamwork/deletedTeams/:deletedTeam-id/channelsThe channels that are either shared with this deleted team or created in this deleted team.
  • POSTCreate channel/teamwork/deletedTeams/:deletedTeam-id/channels
  • GETGet channel/teamwork/deletedTeams/:deletedTeam-id/channels/:channel-idThe channels that are either shared with this deleted team or created in this deleted team.
  • DELETEDelete channel/teamwork/deletedTeams/:deletedTeam-id/channels/:channel-id
  • PATCHUpdate channel/teamwork/deletedTeams/:deletedTeam-id/channels/:channel-id
  • GETGet all messages (channel)/teamwork/deletedTeams/:deletedTeam-id/channels/getAllMessages()Retrieve messages across all channels in a team, including text, audio, and video conversations. To learn more about how to use the Microsoft Teams export…
  • GETGet all retained messages (channel)/teamwork/deletedTeams/:deletedTeam-id/channels/getAllRetainedMessages()Get all retained messages across all channels in a team. To learn more about how to use the Microsoft Teams export APIs to export content, see Export content…

Showing 300 of 366 endpoints. Fork the collection to see all of them.

API details

Base URL
https://graph.microsoft.com/v1.0
Authentication
OAuth 2.0 (authorization code, client credentials flows)
Operations
366 operations on 208 pathsGET 148POST 107DELETE 54PATCH 52PUT 5
Main resources
Teams: primary channel 67Teams: schedule 64Teams: channels 62Teamwork: deleted teams 57Teams 18App catalogs: teams apps 13Teams: tags 10Teamwork 10Teams: installed apps 8Teamwork: installed apps 8
Description format
OpenAPI 3.0.4, API version v1.0

How to test the Microsoft Graph: Teams, channels and apps in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Microsoft Graph: Teams, channels and apps collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code, client credentials flows). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List teams” (GET /teams), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Microsoft Graph: Teams, channels and apps?

Create and manage teams and channels, post and read channel messages, manage members, tabs and installed apps, and work with team templates and the Teams app… It is listed under Communication and has 366 endpoints.

Who publishes the Microsoft Graph: Teams, channels and apps?

It is listed from Microsoft's public API description (an OpenAPI document), not published by Microsoft on Swastik Codes. Anyone who controls microsoft.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Microsoft Graph: Teams, channels and apps?

Requests go to https://graph.microsoft.com/v1.0. Endpoint paths are added to this base URL.

How do I authenticate with the Microsoft Graph: Teams, channels and apps?

With OAuth 2.0 (authorization code, client credentials flows).

How many endpoints does the Microsoft Graph: Teams, channels and apps have?

366 operations on 208 paths (148 GET, 107 POST, 54 DELETE, 52 PATCH, 5 PUT). The largest groups are Teams: primary channel, Teams: schedule, Teams: channels, Teamwork: deleted teams.

Is forking the Microsoft Graph: Teams, channels and apps free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.