Miro
Connect to Miro to access and manage your boards and collaboration spaces. Supports reading boards, creating content, and managing board data.
At Stack AI, security and privacy of our customer's data is our top priority. Today, we are thrilled to announce that Stack AI is now SOC 2 Type II and HIPAA compliant.
Connect to Miro to access and manage your boards and collaboration spaces. Supports reading boards, creating content, and managing board data.
Retrieves a list of boards accessible to the user associated with the provided access token. This endpoint supports filtering and sorting through URL query parameters. Customize the response by specifying `team_id`, `project_id`, or other query parameters. Filtering by `team_id` or `project_id` (or both) returns results instantly. For other filters, allow a few seconds for indexing of newly created boards. If you're an Enterprise customer with Company Admin permissions: - Enable **Content Admin** permissions to retrieve all boards, including private boards (those not explicitly shared with you). For details, see the [Content Admin Permissions for Company Admins](https://help.miro.com/hc/en-us/articles/360012777280-Content-Admin-permissions-for-Company-Admins). - Note that **Private board contents remain inaccessible**. The API allows you to verify their existence but prevents viewing their contents to uph
7 input parameters
3 output parameters
Creates a board with the specified name and sharing policies.<br/><h4>Note</h4> You can only create up to 3 team boards with the free plan.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 3</a><br/>
1 input parameter
3 output parameters
Creates a copy of an existing board. You can also update the name, description, sharing policy, and permissions policy for the new board in the request body.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 4</a><br/>
2 input parameters
3 output parameters
Deletes a board. Deleted boards go to Trash (on paid plans) and can be restored via UI within 90 days after deletion.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 3</a><br/>
1 input parameter
3 output parameters
Retrieves information about a board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:read</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 1</a><br/>
1 input parameter
3 output parameters
Updates a specific board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 2</a><br/>
2 input parameters
3 output parameters
Adds an app card item to a board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 2</a><br/>
2 input parameters
3 output parameters
Deletes an app card item from a board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 3</a><br/>
2 input parameters
3 output parameters
Retrieves information for a specific app card item on a board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:read</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 1</a><br/>
2 input parameters
3 output parameters
Updates an app card item on a board based on the data and style properties provided in the request body.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 2</a><br/>
3 input parameters
3 output parameters
Adds a card item to a board<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 2</a><br/>
2 input parameters
3 output parameters
Deletes a card item from the board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 3</a><br/>
2 input parameters
3 output parameters
Retrieves information for a specific card item on a board<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:read</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 1</a><br/>
2 input parameters
3 output parameters
Updates a card item on a board based on the data and style properties provided in the request body.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 2</a><br/>
3 input parameters
3 output parameters
Retrieves a list of connectors for a specific board. This method returns results using a cursor-based approach. A cursor-paginated method returns a portion of the total set of results based on the limit specified and a cursor that points to the next portion of the results. To retrieve the next portion of the collection, on your next call to the same method, set the `cursor` parameter equal to the `cursor` value you received in the response of the previous request. For example, if you set the `limit` query parameter to `10` and the board contains 20 objects, the first call will return information about the first 10 objects in the response along with a cursor parameter and value. In this example, let's say the cursor parameter value returned in the response is `foo`. If you want to retrieve the next set of objects, on your next call to the same method, set the cursor parameter value to `foo`.<br/><h3>Required sc
3 input parameters
3 output parameters
Adds a connector to a board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 2</a><br/>
2 input parameters
3 output parameters
Deletes the specified connector from the board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 3</a><br/>
2 input parameters
3 output parameters
Retrieves information for a specific connector on a board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:read</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 1</a><br/>
2 input parameters
3 output parameters
Updates a connector on a board based on the data and style properties provided in the request body.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 2</a><br/>
3 input parameters
3 output parameters
Adds a document item to a board by specifying the URL where the document is hosted.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 2</a><br/>
2 input parameters
3 output parameters
Deletes a document item from the board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 3</a><br/>
2 input parameters
3 output parameters
Retrieves information for a specific document item on a board<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:read</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 1</a><br/>
2 input parameters
3 output parameters
Updates a document item on a board<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 2</a><br/>
3 input parameters
3 output parameters
Adds an embed item containing external content to a board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 2</a><br/>
2 input parameters
3 output parameters
Deletes an embed item from the board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 3</a><br/>
2 input parameters
3 output parameters
Retrieves information for a specific embed item on a board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:read</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 1</a><br/>
2 input parameters
3 output parameters
Updates an embed item on a board based on the data properties provided in the request body.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 2</a><br/>
3 input parameters
3 output parameters
Adds an image item to a board by specifying an image URL.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 2</a><br/>
2 input parameters
3 output parameters
Deletes an image item from the board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 3</a><br/>
2 input parameters
3 output parameters
Retrieves information for a specific image item on a board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:read</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 1</a><br/>
2 input parameters
3 output parameters
Updates an image item on a board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 2</a><br/>
3 input parameters
3 output parameters
Retrieves a list of items for a specific board. You can retrieve all items on the board, a list of child items inside a parent item, or a list of specific types of items by specifying URL query parameter values. This method returns results using a cursor-based approach. A cursor-paginated method returns a portion of the total set of results based on the limit specified and a cursor that points to the next portion of the results. To retrieve the next portion of the collection, on your next call to the same method, set the `cursor` parameter equal to the `cursor` value you received in the response of the previous request. For example, if you set the `limit` query parameter to `10` and the board contains 20 objects, the first call will return information about the first 10 objects in the response along with a cursor parameter and value. In this example, let's say the cursor parameter value returned in the respons
4 input parameters
3 output parameters
Deletes an item from a board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 3</a><br/>
2 input parameters
3 output parameters
Retrieves information for a specific item on a board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:read</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 1</a><br/>
2 input parameters
3 output parameters
Updates the position or the parent of an item on a board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 2</a><br/>
3 input parameters
3 output parameters
Retrieves a pageable list of members for a board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:read</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 1</a><br/>
3 input parameters
3 output parameters
Shares the board and Invites new members to collaborate on a board by sending an invitation email. Depending on the board's Sharing policy, there might be various scenarios where membership in the team is required in order to share the board with a user.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 3</a><br/>
2 input parameters
3 output parameters
Removes a board member from a board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 2</a><br/>
2 input parameters
3 output parameters
Retrieves information for a board member.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:read</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 1</a><br/>
2 input parameters
3 output parameters
Updates the role of a board member.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 2</a><br/>
3 input parameters
3 output parameters
Adds a shape item to a board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 2</a><br/>
2 input parameters
3 output parameters
Deletes a shape item from the board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 3</a><br/>
2 input parameters
3 output parameters
Retrieves information for a specific shape item on a board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:read</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 1</a><br/>
2 input parameters
3 output parameters
Updates a shape item on a board based on the data and style properties provided in the request body.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 2</a><br/>
3 input parameters
3 output parameters
Adds a sticky note item to a board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 2</a><br/>
2 input parameters
3 output parameters
Deletes a sticky note item from the board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 3</a><br/>
2 input parameters
3 output parameters
Retrieves information for a specific sticky note item on a board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:read</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 1</a><br/>
2 input parameters
3 output parameters
Updates a sticky note item on a board based on the data and style properties provided in the request body.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 2</a><br/>
3 input parameters
3 output parameters
Adds a text item to a board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 2</a><br/>
2 input parameters
3 output parameters
Deletes a text item from the board<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 3</a><br/>
2 input parameters
3 output parameters
Retrieves information for a specific text item on a board.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:read</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 1</a><br/>
2 input parameters
3 output parameters
Updates a text item on a board based on the data and style properties provided in the request body.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:write</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 2</a><br/>
3 input parameters
3 output parameters