openapi: 3.0.1
info:
title: Miro Developer Platform AI Interaction Logs User group to teams API
version: v2.0
description: '
### Miro Developer Platform concepts
- New to the Miro Developer Platform? Interested in learning more about platform concepts??
[Read our introduction page](https://beta.developers.miro.com/docs/introduction) and familiarize yourself with the Miro Developer Platform capabilities in a few minutes.
### Getting started with the Miro REST API
- [Quickstart (video):](https://beta.developers.miro.com/docs/try-out-the-rest-api-in-less-than-3-minutes) try the REST API in less than 3 minutes.
- [Quickstart (article):](https://beta.developers.miro.com/docs/build-your-first-hello-world-app-1) get started and try the REST API in less than 3 minutes.
### Miro REST API tutorials
Check out our how-to articles with step-by-step instructions and code examples so you can:
- [Get started with OAuth 2.0 and Miro](https://beta.developers.miro.com/docs/getting-started-with-oauth)
### Miro App Examples
Clone our [Miro App Examples repository](https://github.com/miroapp/app-examples) to get inspiration, customize, and explore apps built on top of Miro''s Developer Platform 2.0.
'
servers:
- url: https://api.miro.com/
tags:
- name: User group to teams
paths:
/v2/orgs/{org_id}/groups/{group_id}/teams:
get:
description: Retrieves the list of teams that the user group is a part of.
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using this form.
operationId: enterprise-groups-get-teams parameters: - $ref: '#/components/parameters/pathOrgId' - $ref: '#/components/parameters/pathGroupId' - $ref: '#/components/parameters/queryLimitGroupTeams' - $ref: '#/components/parameters/queryCursorGroupTeams' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GroupTeamsPage' description: Page of teams to user group connections '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '429': $ref: '#/components/responses/429' summary: Get teams of a user group tags: - User group to teams /v2/orgs/{org_id}/groups/{group_id}/teams/{team_id}: get: description: Retrieves information of a team that the user group is a part of in an organization.This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using this form.
operationId: enterprise-groups-get-team parameters: - $ref: '#/components/parameters/pathOrgId' - $ref: '#/components/parameters/pathGroupId' - $ref: '#/components/parameters/pathTeamId' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GroupTeam' description: Team to user group connection '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '429': $ref: '#/components/responses/429' summary: Get user group team tags: - User group to teams components: parameters: pathTeamId: name: team_id description: The ID of a team. in: path required: true schema: type: string example: '3074457345618265000' queryCursorGroupTeams: name: cursor description: A representation of the position of a team in the full set of results. It is used to determine the first item of the resulting set. Leave empty to retrieve items from the beginning. in: query schema: $ref: '#/components/schemas/QueryCursor' pathOrgId: name: org_id description: The ID of an organization. in: path required: true schema: type: string example: '3074457345618265000' queryLimitGroupTeams: name: limit description: The maximum number of teams in the result list. in: query schema: $ref: '#/components/schemas/QueryLimit' pathGroupId: name: group_id description: The ID of a user group. in: path required: true schema: type: string example: '3074457345618265000' schemas: QueryLimit: type: integer format: int32 minimum: 1 maximum: 100 default: 100 example: 100 PageLimit: type: integer format: int32 minimum: 1 maximum: 100 default: 100 example: 100 description: The maximum number of results to return per call. If the number of project in the response is greater than the limit specified, the response returns the cursor parameter with a value. GroupTeamsPage: type: object description: Page of teams that match the search query. required: - limit - size - data properties: limit: $ref: '#/components/schemas/PageLimit' size: $ref: '#/components/schemas/PageSize' data: type: array description: List of teams. items: $ref: '#/components/schemas/GroupTeam' cursor: $ref: '#/components/schemas/PageCursor' type: $ref: '#/components/schemas/PageType' PageSize: type: integer format: int32 minimum: 0 maximum: 100 default: 100 example: 87 description: Number of results returned in the response considering the cursor and the limit values sent in the request. For example, if there are 20 results, the request does not have a cursor value, and the limit set to 10, the size of the results will be 10. In this example, the response will also return a cursor value that can be used to retrieve the next set of 10 remaining results in the collection. PageCursor: type: string description: Indicator of the position of the next page of the result. To retrieve the next page, make another query setting its cursor field to the value returned by the current query. If the value is empty, there are no more pages to fetch. example: '3074457345821140946' QueryCursor: type: string example: '3055557345821140500' GroupTeam: type: object required: - id - role properties: id: type: string description: Team ID example: '3074457345618265000' role: type: string description: Role of the user group in the team enum: - member default: member example: member type: type: string description: Object type default: user-group-team PageType: type: string description: Type of the object returned. default: cursor-list securitySchemes: oAuth2AuthCode: type: oauth2 description: For more information, see https://developers.miro.com/reference/authorization-flow-for-expiring-tokens flows: authorizationCode: authorizationUrl: https://miro.com/oauth/authorize tokenUrl: https://api.miro.com/v1/oauth/token scopes: boards:read: Retrieve information about boards, board members, or items boards:write: Create, update, or delete boards, board members, or items microphone:listen: Access a user's microphone to record audio in an iFrame screen:record: Access a user's screen to record it in an iFrame webcam:record: Allows an iFrame to access a user's camera to record video organizations:read: Read information about the organization, such as name, plan, number of licenses, organization settings, or organization members. organizations:teams:read: Read team information, such as the list of teams, team settings, team members, for an organization. organizations:teams:write: Create or delete teams, update team information, team settings, team members, for an organization. x-settings: publish: true