Microsoft 365 Teams.teamwork Tag API

openapi: 3.2.0
info:
  title: Teams.teamwork Tag API
  version: v1.0
servers:
- url: https://graph.microsoft.com/v1.0/
  description: Core
security:
- azureaadv2: []
tags:
- name: teams.teamworkTag
paths:
  /teams/{team-id}/tags:
    get:
      tags:
      - teams.teamworkTag
      summary: List teamworkTags
      description: Get a list of the tag objects and their properties.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/teamworktag-list?view=graph-rest-1.0
      operationId: team_ListTag
      parameters:
      - name: team-id
        in: path
        description: The unique identifier of team
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: team
      - $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.teamworkTagCollectionResponse'
        default:
          $ref: '#/components/responses/error'
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
      x-ms-docs-operation-type: operation
    post:
      tags:
      - teams.teamworkTag
      summary: Create teamworkTag
      description: Create a standard tag for members in a team.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/teamworktag-post?view=graph-rest-1.0
      operationId: team_CreateTag
      parameters:
      - name: team-id
        in: path
        description: The unique identifier of team
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: team
      requestBody:
        description: New navigation property
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.teamworkTag'
        required: true
      responses:
        2XX:
          description: Created navigation property.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.teamworkTag'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /teams/{team-id}/tags/{teamworkTag-id}:
    get:
      tags:
      - teams.teamworkTag
      summary: Get teamworkTag
      description: Read the properties and relationships of a tag object.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/teamworktag-get?view=graph-rest-1.0
      operationId: team_GetTag
      parameters:
      - name: team-id
        in: path
        description: The unique identifier of team
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: team
      - name: teamworkTag-id
        in: path
        description: The unique identifier of teamworkTag
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: teamworkTag
      - 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.teamworkTag'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
      - teams.teamworkTag
      summary: Update teamworkTag
      description: Update the properties of a tag object.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/teamworktag-update?view=graph-rest-1.0
      operationId: team_UpdateTag
      parameters:
      - name: team-id
        in: path
        description: The unique identifier of team
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: team
      - name: teamworkTag-id
        in: path
        description: The unique identifier of teamworkTag
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: teamworkTag
      requestBody:
        description: New navigation property values
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.teamworkTag'
        required: true
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.teamworkTag'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
      - teams.teamworkTag
      summary: Delete teamworkTag
      description: Delete a tag object permanently.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/teamworktag-delete?view=graph-rest-1.0
      operationId: team_DeleteTag
      parameters:
      - name: team-id
        in: path
        description: The unique identifier of team
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: team
      - name: teamworkTag-id
        in: path
        description: The unique identifier of teamworkTag
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: teamworkTag
      - name: If-Match
        in: header
        description: ETag
        style: simple
        schema:
          type: string
      responses:
        2XX:
          description: Success
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /teams/{team-id}/tags/{teamworkTag-id}/members:
    get:
      tags:
      - teams.teamworkTag
      summary: List members in a teamworkTag
      description: Get a list of the members of a standard tag in a team and their properties.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/teamworktagmember-list?view=graph-rest-1.0
      operationId: team.tag_ListMember
      parameters:
      - name: team-id
        in: path
        description: The unique identifier of team
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: team
      - name: teamworkTag-id
        in: path
        description: The unique identifier of teamworkTag
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: teamworkTag
      - $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.teamworkTagMemberCollectionResponse'
        default:
          $ref: '#/components/responses/error'
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
      x-ms-docs-operation-type: operation
    post:
      tags:
      - teams.teamworkTag
      summary: Create teamworkTagMember
      description: Create a new teamworkTagMember object in a team.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/teamworktagmember-post?view=graph-rest-1.0
      operationId: team.tag_CreateMember
      parameters:
      - name: team-id
        in: path
        description: The unique identifier of team
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: team
      - name: teamworkTag-id
        in: path
        description: The unique identifier of teamworkTag
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: teamworkTag
      requestBody:
        description: New navigation property
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.teamworkTagMember'
        required: true
      responses:
        2XX:
          description: Created navigation property.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.teamworkTagMember'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /teams/{team-id}/tags/{teamworkTag-id}/members/{teamworkTagMember-id}:
    get:
      tags:
      - teams.teamworkTag
      summary: Get teamworkTagMember
      description: Get the properties and relationships of a member of a standard tag in a team.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/teamworktagmember-get?view=graph-rest-1.0
      operationId: team.tag_GetMember
      parameters:
      - name: team-id
        in: path
        description: The unique identifier of team
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: team
      - name: teamworkTag-id
        in: path
        description: The unique identifier of teamworkTag
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: teamworkTag
      - name: teamworkTagMember-id
        in: path
        description: The unique identifier of teamworkTagMember
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: teamworkTagMember
      - 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.teamworkTagMember'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
      - teams.teamworkTag
      summary: Update the navigation property members in teams
      operationId: team.tag_UpdateMember
      parameters:
      - name: team-id
        in: path
        description: The unique identifier of team
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: team
      - name: teamworkTag-id
        in: path
        description: The unique identifier of teamworkTag
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: teamworkTag
      - name: teamworkTagMember-id
        in: path
        description: The unique identifier of teamworkTagMember
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: teamworkTagMember
      requestBody:
        description: New navigation property values
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.teamworkTagMember'
        required: true
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.teamworkTagMember'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
      - teams.teamworkTag
      summary: Delete teamworkTagMember
      description: Delete a member from a standard tag in a team.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/teamworktagmember-delete?view=graph-rest-1.0
      operationId: team.tag_DeleteMember
      parameters:
      - name: team-id
        in: path
        description: The unique identifier of team
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: team
      - name: teamworkTag-id
        in: path
        description: The unique identifier of teamworkTag
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: teamworkTag
      - name: teamworkTagMember-id
        in: path
        description: The unique identifier of teamworkTagMember
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: teamworkTagMember
      - name: If-Match
        in: header
        description: ETag
        style: simple
        schema:
          type: string
      responses:
        2XX:
          description: Success
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /teams/{team-id}/tags/{teamworkTag-id}/members/$count:
    get:
      tags:
      - teams.teamworkTag
      summary: Get the number of the resource
      operationId: team.tag.member_GetCount
      parameters:
      - name: team-id
        in: path
        description: The unique identifier of team
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: team
      - name: teamworkTag-id
        in: path
        description: The unique identifier of teamworkTag
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: teamworkTag
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      responses:
        2XX:
          $ref: '#/components/responses/ODataCountResponse'
        default:
          $ref: '#/components/responses/error'
  /teams/{team-id}/tags/$count:
    get:
      tags:
      - teams.teamworkTag
      summary: Get the number of the resource
      operationId: team.tag_GetCount
      parameters:
      - name: team-id
        in: path
        description: The unique identifier of team
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: team
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      responses:
        2XX:
          $ref: '#/components/responses/ODataCountResponse'
        default:
          $ref: '#/components/responses/error'
components:
  schemas:
    microsoft.graph.teamworkTagType:
      title: teamworkTagType
      enum:
      - standard
      - unknownFutureValue
      type: string
    microsoft.graph.ODataErrors.MainError:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
          x-ms-primary-error-message: true
        target:
          type:
          - string
          - 'null'
        details:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails'
        innerError:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError'
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.ODataError:
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.ErrorDetails:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        target:
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
    microsoft.graph.teamworkTagMemberCollectionResponse:
      title: Collection of teamworkTagMember
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.teamworkTagMember'
        '@odata.nextLink':
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.InnerError:
      type: object
      additionalProperties:
        type: object
      description: The structure of this object is service-specific
    microsoft.graph.teamworkTagCollectionResponse:
      title: Collection of teamworkTag
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.teamworkTag'
        '@odata.nextLink':
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
    microsoft.graph.teamworkTagMember:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.entity'
      - title: teamworkTagMember
        type: object
        properties:
          displayName:
            type:
            - string
            - 'null'
            description: The member's display name.
          tenantId:
            type:
            - string
            - 'null'
            description: The ID of the tenant that the tag member is a part of.
          userId:
            type:
            - string
            - 'null'
            description: The user ID of the member.
        additionalProperties:
          type: object
    microsoft.graph.teamworkTag:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.entity'
      - title: teamworkTag
        type: object
        properties:
          description:
            type:
            - string
            - 'null'
            description: The description of the tag as it appears to the user in Microsoft Teams. A teamworkTag can't have more than 200 teamworkTagMembers.
          displayName:
            type:
            - string
            - 'null'
            description: The name of the tag as it appears to the user in Microsoft Teams.
          memberCount:
            maximum: 2147483647
            minimum: -2147483648
            type:
            - number
            - 'null'
            description: The number of users assigned to the tag.
            format: int32
          tagType:
            $ref: '#/components/schemas/microsoft.graph.teamworkTagType'
          teamId:
            type:
            - string
            - 'null'
            description: ID of the team in which the tag is defined.
          members:
            type: array
            items:
              $ref: '#/components/schemas/microsoft.graph.teamworkTagMember'
            description: Users assigned to the tag.
            x-ms-navigationProperty: true
        additionalProperties:
          type: object
    ODataCountResponse:
      type: integer
      format: int32
    microsoft.graph.entity:
      title: entity
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for an entity. Read-only.
      additionalProperties:
        type: object
  responses:
    microsoft.graph.teamworkTagCollectionResponse:
      description: Retrieved collection
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.teamworkTagCollectionResponse'
    ODataCountResponse:
      description: The count of the resource
      content:
        text/plain:
          schema:
            $ref: '#/components/schemas/ODataCountResponse'
    microsoft.graph.teamworkTagMemberCollectionResponse:
      description: Retrieved collection
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.teamworkTagMemberCollectionResponse'
    error:
      description: error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError'
  parameters:
    top:
      name: $top
      in: query
      description: Show only the first n items
      style: form
      explode: false
      schema:
        minimum: 0
        type: integer
      example: 50
    search:
      name: $search
      in: query
      description: Search items by search phrases
      style: form
      explode: false
      schema:
        type: string
    skip:
      name: $skip
      in: query
      description: Skip the first n items
      style: form
      explode: false
      schema:
        minimum: 0
        type: integer
    filter:
      name: $filter
      in: query
      description: Filter items by property values
      style: form
      explode: false
      schema:
        type: string
    count:
      name: $count
      in: query
      description: Include count of items
      style: form
      explode: false
      schema:
        type: boolean
  securitySchemes:
    azureaadv2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
          scopes: {}