Hierarchy

  • BaseTeam
    • Team

Properties

id: number

Team id

name: string

Team name

orgId: string
picture?: Picture
teamId: number
type?: string

Methods

  • Deletes an existing team.

    Required scope

    organizations:teams:write

    Rate limiting

    Level 4

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users.

    Summary

    Delete team

    Returns Promise<void>

  • Deletes team member from team by id.

    Required scope

    organizations:teams:write

    Rate limiting

    Level 1

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users.

    Summary

    Delete team member from team

    Parameters

    • memberId: string

      The id of a Team member.

    Returns Promise<void>

  • Retrieves all boards that match the search criteria provided in the request. If you are an Enterprise customer and a Company Admin, you can retrieve all boards, including all private boards (boards that haven't been specifically shared with you) by enabling Content Admin permissions. To enable Content Admin permissions, see https://help.miro.com/hc/en-us/articles/360012777280-Content-Admin-permissions-for-Company-Admins. Note that you only get results instantaneously when you filter by team_id. If you use any other filter, you need to give a few seconds for the indexing of newly created boards before retrieving boards.

    Required scope

    boards:read

    Rate limiting

    Level 1

    Returns an iterator which will automatically paginate and fetch all available boards

    Parameters

    • Optional query: Omit<undefined | {
          limit?: string;
          offset?: string;
          owner?: string;
          query?: string;
          sort?: "default" | "last_modified" | "last_opened" | "last_created" | "alphabetically";
          teamId?: string;
      }, "offset">

    Returns AsyncGenerator<Board, void, unknown>

  • Get all team members of the current team

    Required scope

    organizations:teams:read

    Rate limiting

    Level 2

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users.

    Returns an iterator which will automatically paginate and fetch all available team members

    Parameters

    • Optional query: Omit<undefined | {
          cursor?: string;
          filterQuery?: string;
          limit?: number;
      }, "cursor">

    Returns AsyncGenerator<TeamMember, void, unknown>

  • Retrieves board classification for a board.

    Required scope

    boards:read

    Rate limiting

    Level 2

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users.

    Summary

    Get board classification

    Parameters

    • boardId: string

      Unique identifier of the board that you want to retrieve.

    Returns Promise<BoardDataClassification>

  • Retrieves team member by id.

    Required scope

    organizations:teams:read

    Rate limiting

    Level 1

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users.

    Summary

    Get team member

    Parameters

    • memberId: string

      The id of a Team member.

    Returns Promise<TeamMember>

  • Retrieves team settings of an existing team.

    Required scope

    organizations:teams:read

    Rate limiting

    Level 1

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users.

    Summary

    Get team settings

    Parameters

    • teamId: string

      The id of a Team.

    Returns Promise<TeamSettings>

  • Invites a new member to an existing team.

    Required scope

    organizations:teams:write

    Rate limiting

    Level 2

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users.

    Summary

    Invite team members

    Parameters

    Returns Promise<void>

  • Updates board classification for an existing board.

    Required scope

    boards:write

    Rate limiting

    Level 2

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users.

    Summary

    Update board classification

    Parameters

    • boardId: string

      Unique identifier of the board that you want to update.

    • dataClassificationLabelId: DataClassificationLabelId

    Returns Promise<void>

  • Updates an existing team.

    Required scope

    organizations:teams:write

    Rate limiting

    Level 1

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users.

    Summary

    Update team

    Parameters

    Returns Promise<void>

  • Updates team settings of an existing team.

    Required scope

    organizations:teams:write

    Rate limiting

    Level 2

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users.

    Summary

    Update team settings

    Parameters

    Returns Promise<void>