> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Miro

> How to set up the Miro connector, plus the actions that are available.

![Miro](https://stackone-logos.com/api/miro/filled/svg)

v3.1.1[See changelog](https://docs.stackone.com/connectors/miro/changelog.md)

[95 actions](#actions) · 2 auth methods

Design
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/miro/guides/connector-profile/oauth-2-0.md)
>
> Authenticate your app to access Miro boards, teams, and projects on behalf of users

> [card] [OAuth 2.0 (Enterprise organization) · Connector Profile](https://docs.stackone.com/connectors/miro/guides/connector-profile/oauth-2-0-enterprise-organization.md)
>
> For Miro Enterprise organizations. Uses its own Miro app with the organization read permissions, connected by a Company...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/miro/guides/link-account/oauth-2-0.md)

> [card] [OAuth 2.0 (Enterprise organization) · Link Account](https://docs.stackone.com/connectors/miro/guides/link-account/oauth-2-0-enterprise-organization.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

OAuth 2.0

OAuth 2.0 (Enterprise organization)

No auth methods found

Scopes

Select all
|
Clear

boards:read

boards:write

identity:read

organizations:read

organizations:teams:read

projects:read

projects:write

No scopes found

95 actions

ActionDescriptionRequired scopes

Create App Card Item`miro_create_app_card`

Create an app card item on a board

`boards:write`

Get App Card Item`miro_get_app_card`

Retrieve a specific app card item from a board

`boards:read`

Update App Card Item`miro_update_app_card`

Update an app card item on a board

`boards:write`

Delete App Card Item`miro_delete_app_card`

Delete an app card item from a board

`boards:write`

Share Board`miro_share_board`

Share board and invite new members via email

`boards:write`

List Board Members`miro_list_board_members`

Retrieve all members of a specific board

`boards:read`

Get Board Member`miro_get_board_member`

Retrieve a specific board member's information

`boards:read`

Update Board Member`miro_update_board_member`

Update a board member's role

`boards:write`

Remove Board Member`miro_remove_board_member`

Remove a member from a board

`boards:write`

List Boards`miro_list_boards`

Retrieve a list of boards accessible to the authenticated user

`boards:read`

Get Board`miro_get_board`

Retrieve details of a specific board by ID

`boards:read`

Create Board`miro_create_board`

Create a new board in Miro

`boards:write`

Update Board`miro_update_board`

Update an existing board's properties

`boards:write`

Delete Board`miro_delete_board`

Delete a board permanently

`boards:write`

Create Card Item`miro_create_card`

Create a card item on a board

`boards:write`

Get Card Item`miro_get_card`

Retrieve a specific card item from a board

`boards:read`

Update Card Item`miro_update_card`

Update a card item on a board

`boards:write`

Delete Card Item`miro_delete_card`

Delete a card item from a board

`boards:write`

Create Connector`miro_create_connector`

Create a connector between two items on a board

`boards:write`

List Connectors`miro_list_connectors`

Retrieve all connectors from a specific board

`boards:read`

Get Connector`miro_get_connector`

Retrieve a specific connector from a board

`boards:read`

Update Connector`miro_update_connector`

Update a connector on a board

`boards:write`

Delete Connector`miro_delete_connector`

Delete a connector from a board

`boards:write`

Create Document Item`miro_create_document`

Create a document item on a board using URL

`boards:write`

Get Document Item`miro_get_document`

Retrieve a specific document item from a board

`boards:read`

Update Document Item`miro_update_document`

Update a document item on a board

`boards:write`

Delete Document Item`miro_delete_document`

Delete a document item from a board

`boards:write`

Create Document Item From File`miro_create_document_from_file`

Create a document item on a board by uploading a file

`boards:write`

Update Document Item From File`miro_update_document_from_file`

Update a document item on a board by uploading a file

`boards:write`

Create Doc Format Item`miro_create_doc`

Create a doc format item on a board

`boards:write`

Get Doc Format Item`miro_get_doc`

Retrieve a specific doc format item from a board

`boards:read`

Delete Doc Format Item`miro_delete_doc`

Delete a doc format item from a board

`boards:write`

Create Embed Item`miro_create_embed`

Create an embed item with external content on a board

`boards:write`

Get Embed Item`miro_get_embed`

Retrieve a specific embed item from a board

`boards:read`

Update Embed Item`miro_update_embed`

Update an embed item on a board

`boards:write`

Delete Embed Item`miro_delete_embed`

Delete an embed item from a board

`boards:write`

Get OEmbed Data`miro_get_oembed_data`

Retrieve oEmbed data for embedding a Miro board

Create Frame`miro_create_frame`

Create a frame on a board

`boards:write`

Get Frame`miro_get_frame`

Retrieve a specific frame from a board

`boards:read`

Update Frame`miro_update_frame`

Update a frame on a board

`boards:write`

Delete Frame`miro_delete_frame`

Delete a frame from a board

`boards:write`

Get Items Within Frame`miro_list_frame_items`

Retrieve items contained INSIDE a specific frame (use this instead of list\_items for frame contents)

`boards:read`

Create Group`miro_create_group`

Create a group of items on a board

`boards:write`

Get All Groups On A Board`miro_list_groups`

Retrieve all groups and their items from a board

`boards:read`

Get Items Of A Group By ID`miro_list_group_items`

Retrieve items that are part of any group on a board

`boards:read`

Get A Group By Its ID`miro_get_group`

Retrieve a specific group and its items from a board

`boards:read`

Update A Group With New Items`miro_update_group`

Update an existing group by replacing it with new items

`boards:write`

Ungroup Items`miro_ungroup_items`

Ungroup items from a group without deleting them

`boards:write`

Delete Group`miro_delete_group`

Delete a group and optionally its items from a board

`boards:write`

Get Unified Credentials`miro_unified_get_me`

Get the current Miro connection's unified credentials and identity.

List Unified Groups`miro_unified_list_groups`

List unified groups (teams) in the connected Miro organization.

`organizations:teams:read`

Get Unified Group`miro_unified_get_group`

Get a unified Miro group (team) by ID.

`organizations:teams:read`

List Unified Organizations`miro_unified_list_organizations`

List the unified Miro organization the connection belongs to.

`organizations:read`

Get Unified Organization`miro_unified_get_organization`

Get the unified Miro organization by ID.

`organizations:read`

List Unified Roles`miro_unified_list_roles`

List unified roles in the connected Miro organization.

Get Unified Role`miro_unified_get_role`

Get a unified Miro role by ID.

List Unified Users`miro_unified_list_users`

List unified users in the connected Miro organization.

`organizations:read``organizations:teams:read`

Get Unified User`miro_unified_get_user`

Get a unified Miro user by ID.

`organizations:read``organizations:teams:read`

Create Image Item`miro_create_image`

Create an image item on a board using URL

`boards:write`

Get Image Item`miro_get_image`

Retrieve a specific image item from a board

`boards:read`

Update Image Item`miro_update_image`

Update an image item on a board

`boards:write`

Create Image Item From File`miro_create_image_from_file`

Create an image item on a board by uploading a file

`boards:write`

Update Image Item From File`miro_update_image_from_file`

Update an image item on a board by uploading a file

`boards:write`

Delete Image Item`miro_delete_image`

Delete an image item from a board

`boards:write`

List Board Items`miro_list_items`

Retrieve items from a specific board

`boards:read`

Get Board Item`miro_get_item`

Retrieve a specific item from a board

`boards:read`

Update Board Item`miro_update_item`

Update item position or parent on a board

`boards:write`

Delete Board Item`miro_delete_item`

Delete an item from a board

`boards:write`

Create Project`miro_create_project`

Create a new project (space) within a team

`projects:write`

List Projects`miro_list_projects`

Retrieve all projects within a team

`projects:read`

Get Project`miro_get_project`

Retrieve information about a specific project

`projects:read`

Update Project`miro_update_project`

Update project information

`projects:write`

Delete Project`miro_delete_project`

Delete a project from a team

`projects:write`

Create Shape Item`miro_create_shape`

Create a shape item on a board

`boards:write`

Get Shape Item`miro_get_shape`

Retrieve a specific shape item from a board

`boards:read`

Update Shape Item`miro_update_shape`

Update a shape item on a board

`boards:write`

Delete Shape Item`miro_delete_shape`

Delete a shape item from a board

`boards:write`

Create Sticky Note Item`miro_create_sticky_note`

Create a sticky note item on a board

`boards:write`

Get Sticky Note Item`miro_get_sticky_note`

Retrieve a specific sticky note item from a board

`boards:read`

Update Sticky Note Item`miro_update_sticky_note`

Update a sticky note item on a board

`boards:write`

Delete Sticky Note Item`miro_delete_sticky_note`

Delete a sticky note item from a board

`boards:write`

List Board Tags`miro_list_tags`

Retrieve all tags defined on a board (the board's tag palette, NOT tags on a specific item)

`boards:read`

Get Tag`miro_get_tag`

Retrieve a specific tag from a board

`boards:write`

Create Tag`miro_create_tag`

Create a new tag on a board

`boards:write`

Update Tag`miro_update_tag`

Update an existing tag on a board

`boards:write`

Delete Tag`miro_delete_tag`

Delete a tag from a board

`boards:write`

Attach Tag To Item`miro_attach_tag_to_item`

Attach a tag to a board item

`boards:write`

Detach Tag From Item`miro_detach_tag_from_item`

Remove a tag from a board item

`boards:write`

Get Items By Tag`miro_get_items_by_tag`

Retrieve all items that have a specific tag

`boards:read`

Get Tags From Item`miro_get_tags_from_item`

Retrieve tags currently attached to a specific item (use this instead of list\_tags for per-item tags)

`boards:read`

Create Text Item`miro_create_text`

Create a text item on a board

`boards:write`

Get Text Item`miro_get_text`

Retrieve a specific text item from a board

`boards:read`

Update Text Item`miro_update_text`

Update a text item on a board

`boards:write`

Delete Text Item`miro_delete_text`

Delete a text item from a board

`boards:write`

Get Current User`miro_get_current_user`

Get information about the current authenticated user and access token

`identity:read`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.