Microsoft Graph for Teams exposes Microsoft Teams data and capabilities through a single, secure API so you can build integrations and automate Teams at scale. With it, you can create and manage teams, channels, chats, and memberships; post and read messages; schedule and manage meetings and webinars; access presence and call records; and install or configure Teams apps and tabs.
openapi: 3.1.0
info:
title: Microsoft Graph Teams
description: Needs a description.
paths:
/appCatalogs/teamsApps:
description: >-
Provides operations to manage the teamsApps property of the
microsoft.graph.appCatalogs entity.
get:
tags:
- appCatalogs.teamsApp
summary: Microsoft Graph List teamsApp
description: >-
List 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 catalog). To get apps from your organization's app catalog
only, specify organization as the distributionMethod in the request.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/appcatalogs-list-teamsapps?view=graph-rest-1.0
operationId: appCatalogs.ListTeamsApps
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.teamsAppCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- appCatalogs.teamsApp
summary: Microsoft Graph Publish teamsApp
description: "Publish an app to the Microsoft Teams app catalog.\r\nSpecifically, this API publishes the app to your organization's catalog (the tenant app catalog);\r\nthe created resource has a distributionMethod property value of organization. The requiresReview property allows any user to submit an app for review by an administrator. Admins can approve or reject these apps via this API or the Microsoft Teams admin center."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/teamsapp-publish?view=graph-rest-1.0
operationId: appCatalogs.CreateTeamsApps
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsApp'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsApp'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/appCatalogs/teamsApps/{teamsApp-id}:
description: >-
Provides operations to manage the teamsApps property of the
microsoft.graph.appCatalogs entity.
get:
tags:
- appCatalogs.teamsApp
summary: Microsoft Graph Get teamsApps from appCatalogs
operationId: appCatalogs.GetTeamsApps
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsApp'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- appCatalogs.teamsApp
summary: Microsoft Graph Update the navigation property teamsApps in appCatalogs
operationId: appCatalogs.UpdateTeamsApps
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsApp'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsApp'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- appCatalogs.teamsApp
summary: Microsoft Graph Delete teamsApp
description: >-
Delete 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 organization. You can also use this API to remove a
submitted app from the review process.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/teamsapp-delete?view=graph-rest-1.0
operationId: appCatalogs.DeleteTeamsApps
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: teamsApp-id
in: path
description: The unique identifier of teamsApp
required: true
schema:
type: string
x-ms-docs-key-type: teamsApp
/appCatalogs/teamsApps/{teamsApp-id}/appDefinitions:
description: >-
Provides operations to manage the appDefinitions property of the
microsoft.graph.teamsApp entity.
get:
tags:
- appCatalogs.teamsApp
summary: Microsoft Graph Get appDefinitions from appCatalogs
description: The details for each version of the app.
operationId: appCatalogs.teamsApps.ListAppDefinitions
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.teamsAppDefinitionCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- appCatalogs.teamsApp
summary: Microsoft Graph Update teamsApp
description: >-
Update an app previously published to the Microsoft Teams app catalog.
To update an app, the distributionMethod property for the app must be
set to organization. This API specifically updates an app published to
your organization's app catalog (the tenant app catalog).
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/teamsapp-update?view=graph-rest-1.0
operationId: appCatalogs.teamsApps.CreateAppDefinitions
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAppDefinition'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAppDefinition'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: teamsApp-id
in: path
description: The unique identifier of teamsApp
required: true
schema:
type: string
x-ms-docs-key-type: teamsApp
/appCatalogs/teamsApps/{teamsApp-id}/appDefinitions/{teamsAppDefinition-id}:
description: >-
Provides operations to manage the appDefinitions property of the
microsoft.graph.teamsApp entity.
get:
tags:
- appCatalogs.teamsApp
summary: Microsoft Graph Get appDefinitions from appCatalogs
description: The details for each version of the app.
operationId: appCatalogs.teamsApps.GetAppDefinitions
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAppDefinition'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- appCatalogs.teamsApp
summary: Microsoft Graph Publish teamsApp
description: "Publish an app to the Microsoft Teams app catalog.\r\nSpecifically, this API publishes the app to your organization's catalog (the tenant app catalog);\r\nthe created resource has a distributionMethod property value of organization. The requiresReview property allows any user to submit an app for review by an administrator. Admins can approve or reject these apps via this API or the Microsoft Teams admin center."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/teamsapp-publish?view=graph-rest-1.0
operationId: appCatalogs.teamsApps.UpdateAppDefinitions
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAppDefinition'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAppDefinition'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- appCatalogs.teamsApp
summary: Microsoft Graph Delete navigation property appDefinitions for appCatalogs
operationId: appCatalogs.teamsApps.DeleteAppDefinitions
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: teamsApp-id
in: path
description: The unique identifier of teamsApp
required: true
schema:
type: string
x-ms-docs-key-type: teamsApp
- name: teamsAppDefinition-id
in: path
description: The unique identifier of teamsAppDefinition
required: true
schema:
type: string
x-ms-docs-key-type: teamsAppDefinition
/appCatalogs/teamsApps/{teamsApp-id}/appDefinitions/{teamsAppDefinition-id}/bot:
description: >-
Provides operations to manage the bot property of the
microsoft.graph.teamsAppDefinition entity.
get:
tags:
- appCatalogs.teamsApp
summary: Microsoft Graph Get teamworkBot
description: Get the bot associated with a specific definition of the TeamsApp.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/teamworkbot-get?view=graph-rest-1.0
operationId: appCatalogs.teamsApps.appDefinitions.GetBot
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamworkBot'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- appCatalogs.teamsApp
summary: Microsoft Graph Update the navigation property bot in appCatalogs
operationId: appCatalogs.teamsApps.appDefinitions.UpdateBot
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamworkBot'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamworkBot'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- appCatalogs.teamsApp
summary: Microsoft Graph Delete navigation property bot for appCatalogs
operationId: appCatalogs.teamsApps.appDefinitions.DeleteBot
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: teamsApp-id
in: path
description: The unique identifier of teamsApp
required: true
schema:
type: string
x-ms-docs-key-type: teamsApp
- name: teamsAppDefinition-id
in: path
description: The unique identifier of teamsAppDefinition
required: true
schema:
type: string
x-ms-docs-key-type: teamsAppDefinition
/appCatalogs/teamsApps/{teamsApp-id}/appDefinitions/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- appCatalogs.teamsApp
summary: Microsoft Graph Get the number of the resource
operationId: appCatalogs.teamsApps.appDefinitions.GetCount-ad4f
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: teamsApp-id
in: path
description: The unique identifier of teamsApp
required: true
schema:
type: string
x-ms-docs-key-type: teamsApp
/appCatalogs/teamsApps/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- appCatalogs.teamsApp
summary: Microsoft Graph Get the number of the resource
operationId: appCatalogs.teamsApps.GetCount-d4ad
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
/chats/{chat-id}/installedApps/{teamsAppInstallation-id}/teamsApp:
description: >-
Provides operations to manage the teamsApp property of the
microsoft.graph.teamsAppInstallation entity.
get:
tags:
- chats.teamsAppInstallation
summary: Microsoft Graph Get teamsApp from chats
description: The app that is installed.
operationId: chats.installedApps.GetTeamsApp
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsApp'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: teamsAppInstallation-id
in: path
description: The unique identifier of teamsAppInstallation
required: true
schema:
type: string
x-ms-docs-key-type: teamsAppInstallation
/chats/{chat-id}/installedApps/{teamsAppInstallation-id}/teamsAppDefinition:
description: >-
Provides operations to manage the teamsAppDefinition property of the
microsoft.graph.teamsAppInstallation entity.
get:
tags:
- chats.teamsAppInstallation
summary: Microsoft Graph Get teamsAppDefinition from chats
description: The details of this version of the app.
operationId: chats.installedApps.GetTeamsAppDefinition
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAppDefinition'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: teamsAppInstallation-id
in: path
description: The unique identifier of teamsAppInstallation
required: true
schema:
type: string
x-ms-docs-key-type: teamsAppInstallation
/chats/{chat-id}/tabs/{teamsTab-id}/teamsApp:
description: >-
Provides operations to manage the teamsApp property of the
microsoft.graph.teamsTab entity.
get:
tags:
- chats.teamsTab
summary: Microsoft Graph Get teamsApp from chats
description: >-
The application that is linked to the tab. This can't be changed after
tab creation.
operationId: chats.tabs.GetTeamsApp
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsApp'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: teamsTab-id
in: path
description: The unique identifier of teamsTab
required: true
schema:
type: string
x-ms-docs-key-type: teamsTab
/groups/{group-id}/team/channels/{channel-id}/tabs/{teamsTab-id}/teamsApp:
description: >-
Provides operations to manage the teamsApp property of the
microsoft.graph.teamsTab entity.
get:
tags:
- Groups.team
summary: Microsoft Graph Get teamsApp from groups
description: >-
The application that is linked to the tab. This can't be changed after
tab creation.
operationId: groups.team.channels.tabs.GetTeamsApp
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsApp'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: teamsTab-id
in: path
description: The unique identifier of teamsTab
required: true
schema:
type: string
x-ms-docs-key-type: teamsTab
x-ms-docs-grouped-path:
- /groups/{group-id}/team/primaryChannel/tabs/{teamsTab-id}/teamsApp
/groups/{group-id}/team/installedApps/{teamsAppInstallation-id}/teamsApp:
description: >-
Provides operations to manage the teamsApp property of the
microsoft.graph.teamsAppInstallation entity.
get:
tags:
- Groups.team
summary: Microsoft Graph Get teamsApp from groups
description: The app that is installed.
operationId: groups.team.installedApps.GetTeamsApp
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsApp'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
- name: teamsAppInstallation-id
in: path
description: The unique identifier of teamsAppInstallation
required: true
schema:
type: string
x-ms-docs-key-type: teamsAppInstallation
/groups/{group-id}/team/installedApps/{teamsAppInstallation-id}/teamsAppDefinition:
description: >-
Provides operations to manage the teamsAppDefinition property of the
microsoft.graph.teamsAppInstallation entity.
get:
tags:
- Groups.team
summary: Microsoft Graph Get teamsAppDefinition from groups
description: The details of this version of the app.
operationId: groups.team.installedApps.GetTeamsAppDefinition
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAppDefinition'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
- name: teamsAppInstallation-id
in: path
description: The unique identifier of teamsAppInstallation
required: true
schema:
type: string
x-ms-docs-key-type: teamsAppInstallation
/groups/{group-id}/team/primaryChannel/tabs/{teamsTab-id}/teamsApp:
description: >-
Provides operations to manage the teamsApp property of the
microsoft.graph.teamsTab entity.
get:
tags:
- Groups.team
summary: Microsoft Graph Get teamsApp from groups
description: >-
The application that is linked to the tab. This can't be changed after
tab creation.
operationId: groups.team.primaryChannel.tabs.GetTeamsApp
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsApp'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
- name: teamsTab-id
in: path
description: The unique identifier of teamsTab
required: true
schema:
type: string
x-ms-docs-key-type: teamsTab
x-ms-docs-grouped-path:
- >-
/groups/{group-id}/team/channels/{channel-id}/tabs/{teamsTab-id}/teamsApp
/me/chats/{chat-id}/installedApps/{teamsAppInstallation-id}/teamsApp:
description: >-
Provides operations to manage the teamsApp property of the
microsoft.graph.teamsAppInstallation entity.
get:
tags:
- Me.chat
summary: Microsoft Graph Get teamsApp from me
description: The app that is installed.
operationId: me.chats.installedApps.GetTeamsApp
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
# --- truncated at 32 KB (645 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-graph/refs/heads/main/openapi/teams-openapi-original.yml