/miro-org | Type: Application | PCID required: Yes
Tools
miro_org_enterprise_add_project_member
Add member in a project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The ID of the organization to which the project belongs. |
team_id | string | Yes | — | The ID of the team to which the project belongs. |
project_id | string | Yes | — | The ID of the project to which you want to add a user. |
email | string | Yes | — | Email ID of the user. |
role | string | Yes | — | Role of the project member. |
miro_org_enterprise_create_project
Create project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The ID of the organization within which you you want to create a project. |
team_id | string | Yes | — | The ID of the team within which you you want to create a project. |
name | string | Yes | — | Project name. |
miro_org_enterprise_create_team
Create team Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The ID of an organization. |
name | string | Yes | — | Team name. |
miro_org_enterprise_delete_project
Delete project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The ID of the organization from which you want to delete a project. |
team_id | string | Yes | — | The ID of the team from which you want to delete a project. |
project_id | string | Yes | — | The ID of the project that you want to delete. |
miro_org_enterprise_delete_project_member
Remove project member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The ID of the organization to which the project belongs. |
team_id | string | Yes | — | The ID of the team to which the project belongs. |
project_id | string | Yes | — | The ID of the project from which you want to remove a member. |
member_id | string | Yes | — | The ID of the member that you want to remove from a project. |
miro_org_enterprise_delete_team
Delete team Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The ID of an organization. |
team_id | string | Yes | — | The ID of a team. |
miro_org_enterprise_delete_team_member
Delete team member from team Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The ID of an organization. |
team_id | string | Yes | — | The ID of a team. |
member_id | string | Yes | — | The id of the Team Member |
miro_org_enterprise_get_default_team_settings
Get default team settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The id of an Organization. |
miro_org_enterprise_get_organization
Get organization info Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | id of the organization |
miro_org_enterprise_get_organization_member
Get organization member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | id of the organization |
member_id | string | Yes | — | id of the organization member |
miro_org_enterprise_get_organization_members
Get organization members Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
emails | string | No | — | Emails 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 |
role | string | No | — | Filter organization members by role |
license | string | No | — | Filter organization members by license |
active | boolean | No | — | Filter 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”>user deactivation</a>. |
cursor | string | No | — | The 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. |
limit | integer | No | — | Limit for the number of organization members returned in the result list. |
org_id | string | Yes | — | id of the organization |
miro_org_enterprise_get_project
Get project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The ID of the organization from which you want to retrieve the project information. |
team_id | string | Yes | — | The ID of the team from which you want to retrieve the project information. |
project_id | string | Yes | — | The ID of the project for which you want to retrieve the information. |
miro_org_enterprise_get_project_member
Get project member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The ID of the organization to which the project belongs. |
team_id | string | Yes | — | The ID of the team to which the project belongs. |
project_id | string | Yes | — | The ID of the project from which you want to retrieve specific member information. |
member_id | string | Yes | — | The ID of the member for which you want to retrieve information. |
miro_org_enterprise_get_project_members
List of project members Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The ID of the organization to which the project belongs. |
team_id | string | Yes | — | The ID of the team to which the project belongs. |
project_id | string | Yes | — | The ID of the project for which you want to retrieve the list of members. |
limit | integer | No | — | The 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. |
cursor | string | No | — | An 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The ID of the organization to which the project belongs. |
team_id | string | Yes | — | The ID of the team to which the project belongs. |
project_id | string | Yes | — | The ID of the project for which you want to retrieve the project settings. |
miro_org_enterprise_get_projects
List of projects Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The ID of the organization from which you want to retrieve the list of available projects. |
team_id | string | Yes | — | The ID of the team from which you want to retrieve the list of available projects. |
limit | integer | No | — | The 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. |
cursor | string | No | — | An 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The ID of an organization. |
team_id | string | Yes | — | The ID of a team. |
miro_org_enterprise_get_team_member
Get team member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The ID of an organization. |
team_id | string | Yes | — | The ID of a team. |
member_id | string | Yes | — | The id of the Team Member |
miro_org_enterprise_get_team_members
List team members Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The ID of an organization. |
team_id | string | Yes | — | The ID of a team. |
limit | integer | No | — | Limit for the number of team members returned in the result list. |
cursor | string | No | — | An 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. |
role | string | No | — | Role 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The ID of an organization. |
team_id | string | Yes | — | The ID of a team. |
miro_org_enterprise_get_teams
List teams Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The ID of an organization. |
limit | integer | No | — | Limit for the number of teams returned in the result list. |
cursor | string | No | — | An 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. |
name | string | No | — | Name 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The ID of an organization. |
team_id | string | Yes | — | The ID of a team. |
email | string | Yes | — | User email to add to a team |
role | string | No | — | Role 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The ID of an Organization. |
team_id | string | Yes | — | The ID of a Team. |
project_id | string | Yes | — | The ID of a Project. |
name | string | Yes | — | New name of the project. |
miro_org_enterprise_update_project_member
Update project member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The ID of the organization to which the project member belongs. |
team_id | string | Yes | — | The ID of the team to which the project member belongs. |
project_id | string | Yes | — | The ID of a Project. |
member_id | string | Yes | — | The ID of the member whose details you want to update. |
role | string | No | — | Role of the project member. |
miro_org_enterprise_update_project_settings
Update project settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The ID of the organization to which the project belongs. |
team_id | string | Yes | — | The ID of the team to which the project belongs. |
project_id | string | Yes | — | The ID of the project whose settings you want to update. |
sharingPolicySettings | object | No | — | Sharing Policy Settings |
miro_org_enterprise_update_team
Update team Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The ID of an organization. |
team_id | string | Yes | — | The ID of a team. |
name | string | No | — | New name for the team. |
miro_org_enterprise_update_team_member
Update team member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The ID of an organization. |
team_id | string | Yes | — | The ID of a team. |
member_id | string | Yes | — | The id of the Team Member |
role | string | No | — | Role 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | The ID of an organization. |
team_id | string | Yes | — | The ID of a team. |
teamAccountDiscoverySettings | object | No | — | Team account discovery settings |
teamCollaborationSettings | object | No | — | Team collaboration settings |
teamCopyAccessLevelSettings | object | No | — | Team copy access settings |
teamInvitationSettings | object | No | — | Team invitation settings |
teamSharingPolicySettings | object | No | — | Team sharing policy settings |
miro_org_revoke_token_v2
Revoke token (v2) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accessToken | string | Yes | — | The access token to be revoked. |
clientId | string | Yes | — | The client ID associated with the access token. |
clientSecret | string | Yes | — | The client secret associated with the access token. |

