Skip to main content
Miro
95 actions · 2 auth methods
DesignIAM

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · OAuth 2.0

Authenticate your app to access Miro boards, teams, and projects on behalf of users

Connector Profile · OAuth 2.0 (Enterprise organization)

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 (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · OAuth 2.0

Link Account · OAuth 2.0 (Enterprise organization)

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

|
|
95 actions
Action
Description
Required scopes
Create App Card Item
Create an app card item on a board
Get App Card Item
Retrieve a specific app card item from a board
Update App Card Item
Update an app card item on a board
Delete App Card Item
Delete an app card item from a board
Share Board
Share board and invite new members via email
List Board Members
Retrieve all members of a specific board
Get Board Member
Retrieve a specific board member’s information
Update Board Member
Update a board member’s role
Remove Board Member
Remove a member from a board
List Boards
Retrieve a list of boards accessible to the authenticated user
Get Board
Retrieve details of a specific board by ID
Create Board
Create a new board in Miro
Update Board
Update an existing board’s properties
Delete Board
Delete a board permanently
Create Card Item
Create a card item on a board
Get Card Item
Retrieve a specific card item from a board
Update Card Item
Update a card item on a board
Delete Card Item
Delete a card item from a board
Create Connector
Create a connector between two items on a board
List Connectors
Retrieve all connectors from a specific board
Get Connector
Retrieve a specific connector from a board
Update Connector
Update a connector on a board
Delete Connector
Delete a connector from a board
Create Document Item
Create a document item on a board using URL
Get Document Item
Retrieve a specific document item from a board
Update Document Item
Update a document item on a board
Delete Document Item
Delete a document item from a board
Create Document Item From File
Create a document item on a board by uploading a file
Update Document Item From File
Update a document item on a board by uploading a file
Create Doc Format Item
Create a doc format item on a board
Get Doc Format Item
Retrieve a specific doc format item from a board
Delete Doc Format Item
Delete a doc format item from a board
Create Embed Item
Create an embed item with external content on a board
Get Embed Item
Retrieve a specific embed item from a board
Update Embed Item
Update an embed item on a board
Delete Embed Item
Delete an embed item from a board
Get OEmbed Data
Retrieve oEmbed data for embedding a Miro board
Create Frame
Create a frame on a board
Get Frame
Retrieve a specific frame from a board
Update Frame
Update a frame on a board
Delete Frame
Delete a frame from a board
Get Items Within Frame
Retrieve items contained INSIDE a specific frame (use this instead of list_items for frame contents)
Create Group
Create a group of items on a board
Get All Groups On A Board
Retrieve all groups and their items from a board
Get Items Of A Group By ID
Retrieve items that are part of any group on a board
Get A Group By Its ID
Retrieve a specific group and its items from a board
Update A Group With New Items
Update an existing group by replacing it with new items
Ungroup Items
Ungroup items from a group without deleting them
Delete Group
Delete a group and optionally its items from a board
Get Unified Credentials
Get the current Miro connection’s unified credentials and identity.
List Unified Groups
List unified groups (teams) in the connected Miro organization.
Get Unified Group
Get a unified Miro group (team) by ID.
List Unified Organizations
List the unified Miro organization the connection belongs to.
Get Unified Organization
Get the unified Miro organization by ID.
List Unified Roles
List unified roles in the connected Miro organization.
Get Unified Role
Get a unified Miro role by ID.
List Unified Users
List unified users in the connected Miro organization.
Get Unified User
Get a unified Miro user by ID.
Create Image Item
Create an image item on a board using URL
Get Image Item
Retrieve a specific image item from a board
Update Image Item
Update an image item on a board
Create Image Item From File
Create an image item on a board by uploading a file
Update Image Item From File
Update an image item on a board by uploading a file
Delete Image Item
Delete an image item from a board
List Board Items
Retrieve items from a specific board
Get Board Item
Retrieve a specific item from a board
Update Board Item
Update item position or parent on a board
Delete Board Item
Delete an item from a board
Create Project
Create a new project (space) within a team
List Projects
Retrieve all projects within a team
Get Project
Retrieve information about a specific project
Update Project
Update project information
Delete Project
Delete a project from a team
Create Shape Item
Create a shape item on a board
Get Shape Item
Retrieve a specific shape item from a board
Update Shape Item
Update a shape item on a board
Delete Shape Item
Delete a shape item from a board
Create Sticky Note Item
Create a sticky note item on a board
Get Sticky Note Item
Retrieve a specific sticky note item from a board
Update Sticky Note Item
Update a sticky note item on a board
Delete Sticky Note Item
Delete a sticky note item from a board
List Board Tags
Retrieve all tags defined on a board (the board’s tag palette, NOT tags on a specific item)
Get Tag
Retrieve a specific tag from a board
Create Tag
Create a new tag on a board
Update Tag
Update an existing tag on a board
Delete Tag
Delete a tag from a board
Attach Tag To Item
Attach a tag to a board item
Detach Tag From Item
Remove a tag from a board item
Get Items By Tag
Retrieve all items that have a specific tag
Get Tags From Item
Retrieve tags currently attached to a specific item (use this instead of list_tags for per-item tags)
Create Text Item
Create a text item on a board
Get Text Item
Retrieve a specific text item from a board
Update Text Item
Update a text item on a board
Delete Text Item
Delete a text item from a board
Get Current User
Get information about the current authenticated user and access token