Class Team

Hierarchy

BaseTeam
- Team

Properties

id

id: string

Team id

name

name: string

Team name

orgId

orgId: string

`Optional` picture

picture?: Picture

teamId

teamId: string

`Optional` type

type?: string = 'team'

Type of the object returned.

Methods

deleteTeam

deleteTeam(): Promise<void>
Deletes an existing team.
Required scope
organizations:teams:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 4
Enterprise only

This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">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 <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

Summary
Delete team

Returns Promise<void>
- Defined in highlevel/index.ts:204

deleteTeamMember

deleteTeamMember(memberId: string): Promise<void>
Deletes team member from team by id.
Required scope
organizations:teams:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1
Enterprise only

This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">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 <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

Summary
Delete team member from team
Parameters
- memberId: string
  
  The id of the Team Member
Returns Promise<void>
- Defined in highlevel/index.ts:213

getAllBoards

getAllBoards(query?: Omit<undefined | {
    limit?: string;
    offset?: string;
    owner?: string;
    projectId?: string;
    query?: string;
    sort?: "default" | "last_modified" | "last_opened" | "last_created" | "alphabetically";
    teamId?: string;
}, "offset">): AsyncGenerator<Board, void, unknown>
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;
      projectId?: string;
      query?: string;
      sort?: "default" | "last_modified" | "last_opened" | "last_created" | "alphabetically";
      teamId?: string;
  }, "offset">
Returns AsyncGenerator<Board, void, unknown>
Inherited from BaseTeam.getAllBoards
- Defined in highlevel/Team.ts:16

getAllTeamMembers

getAllTeamMembers(query?: Omit<undefined | {
    cursor?: string;
    limit?: number;
    role?: string;
}, "cursor">): AsyncGenerator<TeamMember, 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;
      limit?: number;
      role?: string;
  }, "cursor">
Returns AsyncGenerator<TeamMember, void, unknown>
Inherited from BaseTeam.getAllTeamMembers
- Defined in highlevel/Team.ts:41

getBoardDataClassification

getBoardDataClassification(boardId: string): Promise<BoardDataClassification>
Retrieves board classification for a board.
Required scope
boards:read
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2
Enterprise only

This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">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 <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

Summary
Get board classification
Parameters
- boardId: string
  
  Unique identifier of the board that you want to retrieve.
Returns Promise<BoardDataClassification>
- Defined in highlevel/index.ts:222

getDataClassification

getDataClassification(): Promise<DataClassification>
Retrieves board classification settings for an existing team.
Required scope
organizations:teams:read
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2
Enterprise only

This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">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 <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

Summary
Get team settings

Returns Promise<DataClassification>
- Defined in highlevel/index.ts:269

getTeamMember

getTeamMember(memberId: string): Promise<TeamMember>
Retrieves team member by id.
Required scope
organizations:teams:read
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1
Enterprise only

This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">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 <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

Summary
Get team member
Parameters
- memberId: string
  
  The id of the Team Member
Returns Promise<TeamMember>
- Defined in highlevel/index.ts:306

getTeamSettings

getTeamSettings(teamId: string): Promise<TeamSettings>
Retrieves team settings of an existing team.
Required scope
organizations:teams:read
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1
Enterprise only

This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">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 <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

Summary
Get team settings
Parameters
- teamId: string
  
  The id of the Team.
Returns Promise<TeamSettings>
- Defined in highlevel/index.ts:327

inviteTeamMember

inviteTeamMember(teamMemberInvite: TeamMemberInvite): Promise<void>
Invites a new Miro user to an existing team. The user must exist in your Miro organization. Users who do not exist in your Miro organization can be invited to the team via SCIM and an external identity provider, such as Okta or Azure Active Directory.
Required scope
organizations:teams:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2
Enterprise only

This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">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 <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

Summary
Invite team members
Parameters
- teamMemberInvite: TeamMemberInvite
Returns Promise<void>
- Defined in highlevel/index.ts:297

setBoardDataClassification

setBoardDataClassification(boardId: string, dataClassificationLabelId: DataClassificationLabelId): Promise<void>
Updates board classification for an existing board.
Required scope
boards:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2
Enterprise only

This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">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 <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

Summary
Update board classification
Parameters
- boardId: string
  
  Unique identifier of the board that you want to update.
- dataClassificationLabelId: DataClassificationLabelId
Returns Promise<void>
- Defined in highlevel/index.ts:238

setBoardDataClassificationBulk

setBoardDataClassificationBulk(updateBoardsDataClassificationLabelRequest: UpdateBoardsDataClassificationLabelRequest): Promise<void>
Updates board classification for not-classified only or all boards in an existing team.
Required scope
boards:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 4
Enterprise only

This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">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 <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

Summary
Bulk update boards classification
Parameters
- updateBoardsDataClassificationLabelRequest: UpdateBoardsDataClassificationLabelRequest
Returns Promise<void>
- Defined in highlevel/index.ts:255

setDataClassification

setDataClassification(updateTeamSettingsRequest: UpdateTeamSettingsRequest): Promise<void>
Updates board classification settings for an existing team.
Required scope
organizations:teams:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2
Enterprise only

This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">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 <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

Summary
Update team settings
Parameters
- updateTeamSettingsRequest: UpdateTeamSettingsRequest
Returns Promise<void>
- Defined in highlevel/index.ts:282

updateTeam

updateTeam(teamChanges: TeamChanges): Promise<void>
Updates an existing team.
Required scope
organizations:teams:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1
Enterprise only

This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">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 <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

Summary
Update team
Parameters
- teamChanges: TeamChanges
Returns Promise<void>
- Defined in highlevel/index.ts:318

updateTeamSettings

updateTeamSettings(teamId: string, teamSettingsChanges: TeamSettingsChanges): Promise<void>
Updates team settings of an existing team.
Required scope
organizations:teams:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2
Enterprise only

This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">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 <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

Summary
Update team settings
Parameters
- teamId: string
  
  The id of the Team.
- teamSettingsChanges: TeamSettingsChanges
Returns Promise<void>
- Defined in highlevel/index.ts:339

Class Team

Hierarchy

Index

Properties

Methods

Properties

id

name

orgId

Optional picture

teamId

Optional type

Methods

deleteTeam

Required scope

Rate limiting

Enterprise only

Summary

Returns Promise<void>

deleteTeamMember

Required scope

Rate limiting

Enterprise only

Summary

Parameters

memberId: string

Returns Promise<void>

getAllBoards

Required scope

Rate limiting

Parameters

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

Returns AsyncGenerator<Board, void, unknown>

getAllTeamMembers

Required scope

Rate limiting

Enterprise only

Parameters

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

Returns AsyncGenerator<TeamMember, void, unknown>

getBoardDataClassification

Required scope

Rate limiting

Enterprise only

Summary

Parameters

boardId: string

Returns Promise<BoardDataClassification>

getDataClassification

Required scope

Rate limiting

Enterprise only

Summary

Returns Promise<DataClassification>

getTeamMember

Required scope

Rate limiting

Enterprise only

Summary

Parameters

memberId: string

Returns Promise<TeamMember>

getTeamSettings

Required scope

Rate limiting

Enterprise only

Summary

Parameters

teamId: string

Returns Promise<TeamSettings>

inviteTeamMember

Required scope

Rate limiting

Enterprise only

Summary

Parameters

teamMemberInvite: TeamMemberInvite

Returns Promise<void>

setBoardDataClassification

Required scope

`Optional` picture

`Optional` type

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

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