> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# miro-org
> Miro Org - manage teams, projects, and organization members
**Server path:** `/miro-org` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ------------------------------------------------------------------------------------------------- | ---------------------------- |
| [`miro_org_enterprise_add_project_member`](#miro_org_enterprise_add_project_member) | Add member in a project |
| [`miro_org_enterprise_create_project`](#miro_org_enterprise_create_project) | Create project |
| [`miro_org_enterprise_create_team`](#miro_org_enterprise_create_team) | Create team |
| [`miro_org_enterprise_delete_project`](#miro_org_enterprise_delete_project) | Delete project |
| [`miro_org_enterprise_delete_project_member`](#miro_org_enterprise_delete_project_member) | Remove project member |
| [`miro_org_enterprise_delete_team`](#miro_org_enterprise_delete_team) | Delete team |
| [`miro_org_enterprise_delete_team_member`](#miro_org_enterprise_delete_team_member) | Delete team member from team |
| [`miro_org_enterprise_get_default_team_settings`](#miro_org_enterprise_get_default_team_settings) | Get default team settings |
| [`miro_org_enterprise_get_organization`](#miro_org_enterprise_get_organization) | Get organization info |
| [`miro_org_enterprise_get_organization_member`](#miro_org_enterprise_get_organization_member) | Get organization member |
| [`miro_org_enterprise_get_organization_members`](#miro_org_enterprise_get_organization_members) | Get organization members |
| [`miro_org_enterprise_get_project`](#miro_org_enterprise_get_project) | Get project |
| [`miro_org_enterprise_get_project_member`](#miro_org_enterprise_get_project_member) | Get project member |
| [`miro_org_enterprise_get_project_members`](#miro_org_enterprise_get_project_members) | List of project members |
| [`miro_org_enterprise_get_project_settings`](#miro_org_enterprise_get_project_settings) | Get project settings |
| [`miro_org_enterprise_get_projects`](#miro_org_enterprise_get_projects) | List of projects |
| [`miro_org_enterprise_get_team`](#miro_org_enterprise_get_team) | Get team |
| [`miro_org_enterprise_get_team_member`](#miro_org_enterprise_get_team_member) | Get team member |
| [`miro_org_enterprise_get_team_members`](#miro_org_enterprise_get_team_members) | List team members |
| [`miro_org_enterprise_get_team_settings`](#miro_org_enterprise_get_team_settings) | Get team settings |
| [`miro_org_enterprise_get_teams`](#miro_org_enterprise_get_teams) | List teams |
| [`miro_org_enterprise_invite_team_member`](#miro_org_enterprise_invite_team_member) | Invite team members |
| [`miro_org_enterprise_update_project`](#miro_org_enterprise_update_project) | Update project |
| [`miro_org_enterprise_update_project_member`](#miro_org_enterprise_update_project_member) | Update project member |
| [`miro_org_enterprise_update_project_settings`](#miro_org_enterprise_update_project_settings) | Update project settings |
| [`miro_org_enterprise_update_team`](#miro_org_enterprise_update_team) | Update team |
| [`miro_org_enterprise_update_team_member`](#miro_org_enterprise_update_team_member) | Update team member |
| [`miro_org_enterprise_update_team_settings`](#miro_org_enterprise_update_team_settings) | Update team settings |
| [`miro_org_revoke_token_v2`](#miro_org_revoke_token_v2) | Revoke token (v2) |
| [`miro_org_token_info`](#miro_org_token_info) | Get access token information |
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The ID of the organization to which the project belongs."
},
"team_id": {
"type": "string",
"description": "The ID of the team to which the project belongs."
},
"project_id": {
"type": "string",
"description": "The ID of the project to which you want to add a user."
},
"email": {
"type": "string",
"description": "Email ID of the user."
},
"role": {
"type": "string",
"description": "Role of the project member.",
"enum": [
"owner",
"editor",
"viewer",
"commentator",
"coowner"
]
}
},
"required": [
"PCID",
"org_id",
"team_id",
"project_id",
"email",
"role"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The ID of the organization within which you you want to create a project."
},
"team_id": {
"type": "string",
"description": "The ID of the team within which you you want to create a project."
},
"name": {
"type": "string",
"description": "Project name."
}
},
"required": [
"PCID",
"org_id",
"team_id",
"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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The ID of an organization."
},
"name": {
"type": "string",
"description": "Team name."
}
},
"required": [
"PCID",
"org_id",
"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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The ID of the organization from which you want to delete a project."
},
"team_id": {
"type": "string",
"description": "The ID of the team from which you want to delete a project."
},
"project_id": {
"type": "string",
"description": "The ID of the project that you want to delete."
}
},
"required": [
"PCID",
"org_id",
"team_id",
"project_id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The ID of the organization to which the project belongs."
},
"team_id": {
"type": "string",
"description": "The ID of the team to which the project belongs."
},
"project_id": {
"type": "string",
"description": "The ID of the project from which you want to remove a member."
},
"member_id": {
"type": "string",
"description": "The ID of the member that you want to remove from a project."
}
},
"required": [
"PCID",
"org_id",
"team_id",
"project_id",
"member_id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The ID of an organization."
},
"team_id": {
"type": "string",
"description": "The ID of a team."
}
},
"required": [
"PCID",
"org_id",
"team_id"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The ID of an organization."
},
"team_id": {
"type": "string",
"description": "The ID of a team."
},
"member_id": {
"type": "string",
"description": "The id of the Team Member"
}
},
"required": [
"PCID",
"org_id",
"team_id",
"member_id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The id of an Organization."
}
},
"required": [
"PCID",
"org_id"
]
}
```
***
## miro\_org\_enterprise\_get\_organization
Get organization info
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ---------------------- |
| `org_id` | string | Yes | — | id of the organization |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "id of the organization"
}
},
"required": [
"PCID",
"org_id"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "id of the organization"
},
"member_id": {
"type": "string",
"description": "id of the organization member"
}
},
"required": [
"PCID",
"org_id",
"member_id"
]
}
```
***
## 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 \. |
| `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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"emails": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Filter organization members by role",
"enum": [
"organization_internal_admin",
"organization_internal_user",
"organization_external_user",
"organization_team_guest_user",
"unknown"
]
},
"license": {
"type": "string",
"description": "Filter organization members by license",
"enum": [
"advanced",
"standard",
"basic",
"full",
"occasional",
"free",
"free_restricted",
"full_trial",
"unknown"
]
},
"active": {
"type": "boolean",
"description": "Filter results based on whether the user is active or deactivated. Learn more about user deactivation."
},
"cursor": {
"type": "string",
"description": "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": {
"type": "integer",
"description": "Limit for the number of organization members returned in the result list."
},
"org_id": {
"type": "string",
"description": "id of the organization"
}
},
"required": [
"PCID",
"org_id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The ID of the organization from which you want to retrieve the project information."
},
"team_id": {
"type": "string",
"description": "The ID of the team from which you want to retrieve the project information."
},
"project_id": {
"type": "string",
"description": "The ID of the project for which you want to retrieve the information."
}
},
"required": [
"PCID",
"org_id",
"team_id",
"project_id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The ID of the organization to which the project belongs."
},
"team_id": {
"type": "string",
"description": "The ID of the team to which the project belongs."
},
"project_id": {
"type": "string",
"description": "The ID of the project from which you want to retrieve specific member information."
},
"member_id": {
"type": "string",
"description": "The ID of the member for which you want to retrieve information."
}
},
"required": [
"PCID",
"org_id",
"team_id",
"project_id",
"member_id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The ID of the organization to which the project belongs."
},
"team_id": {
"type": "string",
"description": "The ID of the team to which the project belongs."
},
"project_id": {
"type": "string",
"description": "The ID of the project for which you want to retrieve the list of members."
},
"limit": {
"type": "integer",
"description": "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": {
"type": "string",
"description": "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."
}
},
"required": [
"PCID",
"org_id",
"team_id",
"project_id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The ID of the organization to which the project belongs."
},
"team_id": {
"type": "string",
"description": "The ID of the team to which the project belongs."
},
"project_id": {
"type": "string",
"description": "The ID of the project for which you want to retrieve the project settings."
}
},
"required": [
"PCID",
"org_id",
"team_id",
"project_id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The ID of the organization from which you want to retrieve the list of available projects."
},
"team_id": {
"type": "string",
"description": "The ID of the team from which you want to retrieve the list of available projects."
},
"limit": {
"type": "integer",
"description": "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": {
"type": "string",
"description": "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."
}
},
"required": [
"PCID",
"org_id",
"team_id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The ID of an organization."
},
"team_id": {
"type": "string",
"description": "The ID of a team."
}
},
"required": [
"PCID",
"org_id",
"team_id"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The ID of an organization."
},
"team_id": {
"type": "string",
"description": "The ID of a team."
},
"member_id": {
"type": "string",
"description": "The id of the Team Member"
}
},
"required": [
"PCID",
"org_id",
"team_id",
"member_id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The ID of an organization."
},
"team_id": {
"type": "string",
"description": "The ID of a team."
},
"limit": {
"type": "integer",
"description": "Limit for the number of team members returned in the result list."
},
"cursor": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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."
}
},
"required": [
"PCID",
"org_id",
"team_id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The ID of an organization."
},
"team_id": {
"type": "string",
"description": "The ID of a team."
}
},
"required": [
"PCID",
"org_id",
"team_id"
]
}
```
***
## 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". |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The ID of an organization."
},
"limit": {
"type": "integer",
"description": "Limit for the number of teams returned in the result list."
},
"cursor": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Name query. Filters teams by name using case insensitive partial match. A value \"dev\" will return both \"Developer's team\" and \"Team for developers\"."
}
},
"required": [
"PCID",
"org_id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The ID of an organization."
},
"team_id": {
"type": "string",
"description": "The ID of a team."
},
"email": {
"type": "string",
"description": "User email to add to a team"
},
"role": {
"type": "string",
"description": "Role of the team member. * \"member\": Team member with full member permissions. * \"admin\": Admin of a team. Team member with permission to manage team.",
"enum": [
"member",
"admin"
]
}
},
"required": [
"PCID",
"org_id",
"team_id",
"email"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The ID of an Organization."
},
"team_id": {
"type": "string",
"description": "The ID of a Team."
},
"project_id": {
"type": "string",
"description": "The ID of a Project."
},
"name": {
"type": "string",
"description": "New name of the project."
}
},
"required": [
"PCID",
"org_id",
"team_id",
"project_id",
"name"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The ID of the organization to which the project member belongs."
},
"team_id": {
"type": "string",
"description": "The ID of the team to which the project member belongs."
},
"project_id": {
"type": "string",
"description": "The ID of a Project."
},
"member_id": {
"type": "string",
"description": "The ID of the member whose details you want to update."
},
"role": {
"type": "string",
"description": "Role of the project member.",
"enum": [
"owner",
"editor",
"viewer",
"commentator",
"coowner"
]
}
},
"required": [
"PCID",
"org_id",
"team_id",
"project_id",
"member_id"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The ID of the organization to which the project belongs."
},
"team_id": {
"type": "string",
"description": "The ID of the team to which the project belongs."
},
"project_id": {
"type": "string",
"description": "The ID of the project whose settings you want to update."
},
"sharingPolicySettings": {
"type": "object",
"description": "Sharing Policy Settings",
"properties": {
"teamAccess": {
"type": "string",
"description": "Team access * \"private\": Only the members of the project can access the information within the project. * \"view\": Anyone in the team can view the information in within the project.",
"enum": [
"private",
"view"
]
}
}
}
},
"required": [
"PCID",
"org_id",
"team_id",
"project_id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The ID of an organization."
},
"team_id": {
"type": "string",
"description": "The ID of a team."
},
"name": {
"type": "string",
"description": "New name for the team."
}
},
"required": [
"PCID",
"org_id",
"team_id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The ID of an organization."
},
"team_id": {
"type": "string",
"description": "The ID of a team."
},
"member_id": {
"type": "string",
"description": "The id of the Team Member"
},
"role": {
"type": "string",
"description": "Role of the team member. * \"member\": Team member with full member permissions. * \"admin\": Admin of a team. Team member with permission to manage team.",
"enum": [
"member",
"admin"
]
}
},
"required": [
"PCID",
"org_id",
"team_id",
"member_id"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "The ID of an organization."
},
"team_id": {
"type": "string",
"description": "The ID of a team."
},
"teamAccountDiscoverySettings": {
"type": "object",
"description": "Team account discovery settings",
"properties": {
"accountDiscovery": {
"type": "string",
"description": "* \"hidden\": Only invited users can see and access the team. * \"request\": Members of organization can find and request to join with admin approval. * \"join\": Members of organization can find and join.",
"enum": [
"hidden",
"request",
"join"
]
}
}
},
"teamCollaborationSettings": {
"type": "object",
"description": "Team collaboration settings",
"properties": {
"coOwnerRole": {
"type": "string",
"description": "* \"enabled\": Enable Co-owner role on boards and projects * \"disabled\": Disabled Co-owner role on boards and projects",
"enum": [
"enabled",
"disabled"
]
}
}
},
"teamCopyAccessLevelSettings": {
"type": "object",
"description": "Team copy access settings",
"properties": {
"copyAccessLevel": {
"type": "string",
"description": "* \"anyone\": Anyone with the board access can copy board content on newly created boards. * \"team_members\": Team members can copy board content on newly created boards. * \"team_editors\": Team members with editing rights can copy board content on newly created boards. * \"board_owner\": Board owners only can copy board content on newly created boards.",
"enum": [
"anyone",
"team_members",
"team_editors",
"board_owner"
]
},
"copyAccessLevelLimitation": {
"type": "string",
"description": "* \"anyone\": Team members and users outside team can be given permission to copy board content. * \"team_members\": Only team members can be given permission to copy board content.",
"enum": [
"anyone",
"team_members"
]
}
}
},
"teamInvitationSettings": {
"type": "object",
"description": "Team invitation settings",
"properties": {
"inviteExternalUsers": {
"type": "string",
"description": "* \"allowed\": Allow non-team collaborators for team * \"not_allowed\": Not Allow non-team collaborators for team",
"enum": [
"allowed",
"not_allowed"
]
},
"whoCanInvite": {
"type": "string",
"description": "* \"only_org_admins\": Company admins only can invite * \"admins\": Company admins and team admins can invite * \"all_members\": All team members can invite",
"enum": [
"only_org_admins",
"admins",
"all_members"
]
}
}
},
"teamSharingPolicySettings": {
"type": "object",
"description": "Team sharing policy settings",
"properties": {
"allowListedDomains": {
"type": "array",
"items": {
"type": "string"
},
"description": "Allow listed domains"
},
"createAssetAccessLevel": {
"type": "string",
"description": "* \"company_admins\": Only company admins can create assets in a team * \"admins\": Both team and company admins can create assets in a team. * \"all_members\": all_members",
"enum": [
"company_admins",
"admins",
"all_members"
]
},
"defaultBoardAccess": {
"type": "string",
"description": "Default board access * \"private\": Only board owners can access * \"view\": Anyone in the team can view * \"comment\": Anyone in the team can comment * \"edit\": Anyone in the team can edit",
"enum": [
"private",
"view",
"comment",
"edit"
]
},
"defaultBoardSharingAccess": {
"type": "string",
"description": "Indicates who can change board access and invite users to boards in this team, by default. * \"team_members_with_editing_rights\": Any team member with editing rights on the board. * \"owner_and_coowners\": Only the owner and co-owners of the board.",
"enum": [
"team_members_with_editing_rights",
"owner_and_coowners"
]
},
"defaultOrganizationAccess": {
"type": "string",
"description": "Default organization access * \"private\": Only board owners can access * \"view\": Anyone in the team can view * \"comment\": Anyone in the team can comment * \"edit\": Anyone in the team can edit",
"enum": [
"private",
"view",
"comment",
"edit"
]
},
"defaultProjectAccess": {
"type": "string",
"description": "Default project access * \"private\": Only board owners can access * \"view\": Anyone in the team can view",
"enum": [
"private",
"view"
]
},
"moveBoardToAccount": {
"type": "string",
"description": "* \"allowed\": Allow move board to team * \"not_allowed\": Not allow move board to team",
"enum": [
"allowed",
"not_allowed"
]
},
"restrictAllowedDomains": {
"type": "string",
"description": "* \"enabled\": Enabled. Restrict to listed domain. * \"disabled\": Disabled. No domain restriction. * \"enabled_with_external_user_access\": Enabled. Restrict to listed domain but allows external users to access.",
"enum": [
"enabled",
"enabled_with_external_user_access",
"disabled"
]
},
"sharingOnAccount": {
"type": "string",
"description": "* \"allowed\": Allow sharing on team * \"not_allowed\": Not allow sharing on team",
"enum": [
"allowed",
"not_allowed"
]
},
"sharingOnOrganization": {
"type": "string",
"description": "* \"allowed\": Allow sharing on organization * \"allowed_with_editing\": Allow sharing with editing on organization * \"not_allowed\": Not allow sharing on organization",
"enum": [
"allowed",
"allowed_with_editing",
"not_allowed"
]
},
"sharingViaPublicLink": {
"type": "string",
"description": "* \"allowed\": Allow sharing via public link * \"allowed_with_editing\": Allow sharing with editing via public link * \"not_allowed\": Not allow sharing via public link",
"enum": [
"allowed",
"allowed_with_editing",
"not_allowed"
]
}
}
}
},
"required": [
"PCID",
"org_id",
"team_id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accessToken": {
"type": "string",
"description": "The access token to be revoked."
},
"clientId": {
"type": "string",
"description": "The client ID associated with the access token."
},
"clientSecret": {
"type": "string",
"description": "The client secret associated with the access token."
}
},
"required": [
"PCID",
"accessToken",
"clientId",
"clientSecret"
]
}
```
***
## miro\_org\_token\_info
Get access token information
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```