Skip to main content
Server path: /miro-org | Type: Application | PCID required: Yes

Tools

ToolDescription
miro_org_enterprise_add_project_memberAdd member in a project
miro_org_enterprise_create_projectCreate project
miro_org_enterprise_create_teamCreate team
miro_org_enterprise_delete_projectDelete project
miro_org_enterprise_delete_project_memberRemove project member
miro_org_enterprise_delete_teamDelete team
miro_org_enterprise_delete_team_memberDelete team member from team
miro_org_enterprise_get_default_team_settingsGet default team settings
miro_org_enterprise_get_organizationGet organization info
miro_org_enterprise_get_organization_memberGet organization member
miro_org_enterprise_get_organization_membersGet organization members
miro_org_enterprise_get_projectGet project
miro_org_enterprise_get_project_memberGet project member
miro_org_enterprise_get_project_membersList of project members
miro_org_enterprise_get_project_settingsGet project settings
miro_org_enterprise_get_projectsList of projects
miro_org_enterprise_get_teamGet team
miro_org_enterprise_get_team_memberGet team member
miro_org_enterprise_get_team_membersList team members
miro_org_enterprise_get_team_settingsGet team settings
miro_org_enterprise_get_teamsList teams
miro_org_enterprise_invite_team_memberInvite team members
miro_org_enterprise_update_projectUpdate project
miro_org_enterprise_update_project_memberUpdate project member
miro_org_enterprise_update_project_settingsUpdate project settings
miro_org_enterprise_update_teamUpdate team
miro_org_enterprise_update_team_memberUpdate team member
miro_org_enterprise_update_team_settingsUpdate team settings
miro_org_revoke_token_v2Revoke token (v2)
miro_org_token_infoGet access token information

miro_org_enterprise_add_project_member

Add member in a project Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe ID of the organization to which the project belongs.
team_idstringYesThe ID of the team to which the project belongs.
project_idstringYesThe ID of the project to which you want to add a user.
emailstringYesEmail ID of the user.
rolestringYesRole of the project member.

miro_org_enterprise_create_project

Create project Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe ID of the organization within which you you want to create a project.
team_idstringYesThe ID of the team within which you you want to create a project.
namestringYesProject name.

miro_org_enterprise_create_team

Create team Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe ID of an organization.
namestringYesTeam name.

miro_org_enterprise_delete_project

Delete project Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe ID of the organization from which you want to delete a project.
team_idstringYesThe ID of the team from which you want to delete a project.
project_idstringYesThe ID of the project that you want to delete.

miro_org_enterprise_delete_project_member

Remove project member Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe ID of the organization to which the project belongs.
team_idstringYesThe ID of the team to which the project belongs.
project_idstringYesThe ID of the project from which you want to remove a member.
member_idstringYesThe ID of the member that you want to remove from a project.

miro_org_enterprise_delete_team

Delete team Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe ID of an organization.
team_idstringYesThe ID of a team.

miro_org_enterprise_delete_team_member

Delete team member from team Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe ID of an organization.
team_idstringYesThe ID of a team.
member_idstringYesThe id of the Team Member

miro_org_enterprise_get_default_team_settings

Get default team settings Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe id of an Organization.

miro_org_enterprise_get_organization

Get organization info Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesid of the organization

miro_org_enterprise_get_organization_member

Get organization member Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesid of the organization
member_idstringYesid of the organization member

miro_org_enterprise_get_organization_members

Get organization members Parameters:
ParameterTypeRequiredDefaultDescription
emailsstringNoEmails of the organization members you want to retrieve. If you specify a value for the emails parameter, only the emails parameter is considered. All other filtering parameters are ignored. Maximum emails size is 10. Example: emails=someEmail1@miro.com,someEmail2@miro.com
rolestringNoFilter organization members by role
licensestringNoFilter organization members by license
activebooleanNoFilter results based on whether the user is active or deactivated. Learn more about <a target=“blank” href=“https://help.miro.com/hc/en-us/articles/360025025894-Deactivated-users”&gt;user deactivation</a>.
cursorstringNoThe ID of the organization member used as the reference for pagination. To retrieve the first portion of the collection don’t pass a cursor value. To retrieve the next portion of the collection, set the cursor parameter value to the ID of the last organization member you received in the response of the previous request.
limitintegerNoLimit for the number of organization members returned in the result list.
org_idstringYesid of the organization

miro_org_enterprise_get_project

Get project Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe ID of the organization from which you want to retrieve the project information.
team_idstringYesThe ID of the team from which you want to retrieve the project information.
project_idstringYesThe ID of the project for which you want to retrieve the information.

miro_org_enterprise_get_project_member

Get project member Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe ID of the organization to which the project belongs.
team_idstringYesThe ID of the team to which the project belongs.
project_idstringYesThe ID of the project from which you want to retrieve specific member information.
member_idstringYesThe ID of the member for which you want to retrieve information.

miro_org_enterprise_get_project_members

List of project members Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe ID of the organization to which the project belongs.
team_idstringYesThe ID of the team to which the project belongs.
project_idstringYesThe ID of the project for which you want to retrieve the list of members.
limitintegerNoThe maximum number of results to return per call. If the number of project members in the response is greater than the limit specified, the response returns the cursor parameter with a value.
cursorstringNoAn indicator of the position of a page in the full set of results. To obtain the first page leave it empty. To obtain subsequent pages set it to the value returned in the cursor field of the previous request.

miro_org_enterprise_get_project_settings

Get project settings Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe ID of the organization to which the project belongs.
team_idstringYesThe ID of the team to which the project belongs.
project_idstringYesThe ID of the project for which you want to retrieve the project settings.

miro_org_enterprise_get_projects

List of projects Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe ID of the organization from which you want to retrieve the list of available projects.
team_idstringYesThe ID of the team from which you want to retrieve the list of available projects.
limitintegerNoThe maximum number of results to return per call. If the number of projects in the response is greater than the limit specified, the response returns the cursor parameter with a value.
cursorstringNoAn indicator of the position of a page in the full set of results. To obtain the first page leave it empty. To obtain subsequent pages set it to the value returned in the cursor field of the previous request.

miro_org_enterprise_get_team

Get team Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe ID of an organization.
team_idstringYesThe ID of a team.

miro_org_enterprise_get_team_member

Get team member Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe ID of an organization.
team_idstringYesThe ID of a team.
member_idstringYesThe id of the Team Member

miro_org_enterprise_get_team_members

List team members Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe ID of an organization.
team_idstringYesThe ID of a team.
limitintegerNoLimit for the number of team members returned in the result list.
cursorstringNoAn indicator of the position of a page in the full set of results. To obtain the first page leave it empty. To obtain subsequent pages set it to the value returned in the cursor field of the previous request.
rolestringNoRole query. Filters members by role using full word match. Accepted values are: * “member”: Team member with full member permissions. * “admin”: Admin of a team. Team member with permission to manage team. * “non_team”: External user, non-team user. * “team_guest”: (Deprecated) Team-guest user, user with access only to a team without access to organization.

miro_org_enterprise_get_team_settings

Get team settings Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe ID of an organization.
team_idstringYesThe ID of a team.

miro_org_enterprise_get_teams

List teams Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe ID of an organization.
limitintegerNoLimit for the number of teams returned in the result list.
cursorstringNoAn indicator of the position of a page in the full set of results. To obtain the first page leave it empty. To obtain subsequent pages set it to the value returned in the cursor field of the previous request.
namestringNoName query. Filters teams by name using case insensitive partial match. A value “dev” will return both “Developer’s team” and “Team for developers”.

miro_org_enterprise_invite_team_member

Invite team members Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe ID of an organization.
team_idstringYesThe ID of a team.
emailstringYesUser email to add to a team
rolestringNoRole of the team member. * “member”: Team member with full member permissions. * “admin”: Admin of a team. Team member with permission to manage team.

miro_org_enterprise_update_project

Update project Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe ID of an Organization.
team_idstringYesThe ID of a Team.
project_idstringYesThe ID of a Project.
namestringYesNew name of the project.

miro_org_enterprise_update_project_member

Update project member Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe ID of the organization to which the project member belongs.
team_idstringYesThe ID of the team to which the project member belongs.
project_idstringYesThe ID of a Project.
member_idstringYesThe ID of the member whose details you want to update.
rolestringNoRole of the project member.

miro_org_enterprise_update_project_settings

Update project settings Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe ID of the organization to which the project belongs.
team_idstringYesThe ID of the team to which the project belongs.
project_idstringYesThe ID of the project whose settings you want to update.
sharingPolicySettingsobjectNoSharing Policy Settings

miro_org_enterprise_update_team

Update team Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe ID of an organization.
team_idstringYesThe ID of a team.
namestringNoNew name for the team.

miro_org_enterprise_update_team_member

Update team member Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe ID of an organization.
team_idstringYesThe ID of a team.
member_idstringYesThe id of the Team Member
rolestringNoRole of the team member. * “member”: Team member with full member permissions. * “admin”: Admin of a team. Team member with permission to manage team.

miro_org_enterprise_update_team_settings

Update team settings Parameters:
ParameterTypeRequiredDefaultDescription
org_idstringYesThe ID of an organization.
team_idstringYesThe ID of a team.
teamAccountDiscoverySettingsobjectNoTeam account discovery settings
teamCollaborationSettingsobjectNoTeam collaboration settings
teamCopyAccessLevelSettingsobjectNoTeam copy access settings
teamInvitationSettingsobjectNoTeam invitation settings
teamSharingPolicySettingsobjectNoTeam sharing policy settings

miro_org_revoke_token_v2

Revoke token (v2) Parameters:
ParameterTypeRequiredDefaultDescription
accessTokenstringYesThe access token to be revoked.
clientIdstringYesThe client ID associated with the access token.
clientSecretstringYesThe client secret associated with the access token.

miro_org_token_info

Get access token information