Miro REST API
Miro Developer Platform concepts New to the Miro Developer Platform? Interested in learning more about platform concepts?? [Read our introduction…
Productivity & workspace#openapi
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Miro Developer Platform concepts
- New to the Miro Developer Platform? Interested in learning more about platform concepts??
Read our introduction page and familiarize yourself with the Miro Developer Platform capabilities in a few minutes.
Getting started with the Miro REST API
- Quickstart (video): try the REST API in less than 3 minutes.
- Quickstart (article): get started and try the REST API in less than 3 minutes.
Miro REST API tutorials
Check out our how-to articles with step-by-step instructions and code examples so you can:
Miro App Examples
Clone our Miro App Examples repository to get inspiration, customize, and explore apps built on top of Miro's Developer Platform 2.0.
Endpoints 197
tokens
- POSTRevoke token (v1)
/v1/oauth/revoke?access_token=stringDeprecated. <p><b>Please use the new revoke endpoint <code>/v2/oauth/revoke</code>. This endpoint is considered vulnerable and deprecated due to access token… - GETGet access token information
/v1/oauth-tokenGet information about an access token, such as the token type, scopes, team, user, token creation date and time, and the user who created the token.
AI Interaction Logs
- GETGet AI interaction logs (Beta)
/v2/orgs/:org_id/ai-interaction-logs?from=2026-01-30T17:26:50Z&to=2036-03-30T17:26:50ZRetrieves AI interaction logs for your organization. AI interaction logs capture user interactions with AI features in Miro. You can retrieve results for a…
Audit Logs
- GETGet audit logs
/v2/audit/logs?createdAfter=2023-03-30T17:26:50.000Z&createdBefore=2023-04-30T17:26:50.000ZRetrieves a page of audit events from the last 90 days. If you want to retrieve data that is older than 90 days, you can use the <a target=_blank…
Board classification: Organization level
- GETGet organization settings
/v2/orgs/:org_id/data-classification-settingsRetrieves board classification settings for an existing organization.<br/><h3>Required scope</h3> <a target=_blank…
Board classification: Team level
- PATCHBulk update boards classification
/v2/orgs/:org_id/teams/:team_id/data-classificationUpdates board classification for not-classified only or all boards in an existing team.<br/><h3>Required scope</h3> <a target=_blank… - GETGet team settings
/v2/orgs/:org_id/teams/:team_id/data-classification-settingsRetrieves board classification settings for an existing team.<br/><h3>Required scope</h3> <a target=_blank… - PATCHUpdate team settings
/v2/orgs/:org_id/teams/:team_id/data-classification-settingsUpdates board classification settings for an existing team.<br/><h3>Required scope</h3> <a target=_blank…
Board classification: Board level
- GETGet board classification
/v2/orgs/:org_id/teams/:team_id/boards/:board_id/data-classificationRetrieves board classification for a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:read</a>… - POSTUpdate board classification
/v2/orgs/:org_id/teams/:team_id/boards/:board_id/data-classificationUpdates board classification for an existing board.<br/><h3>Required scope</h3> <a target=_blank…
doc formats
- POSTCreate doc format item
/v2/boards/:board_id/docsAdds a doc format item to a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>… - GETGet doc format item
/v2/boards/:board_id/docs/:item_idRetrieves information for a specific doc format item on a board.<br/><h3>Required scope</h3> <a target=_blank… - DELETEDelete doc format item
/v2/boards/:board_id/docs/:item_idDeletes a doc format item from the board<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>…
Legal holds
- GETGet all cases
/v2/orgs/:org_id/casesRetrieves the list of eDiscovery cases in an organization.<br/><h3>Required scope</h3> <a target=_blank… - POSTCreate case
/v2/orgs/:org_id/casesCreating a case for legal hold is the first critical step in the eDiscovery process when litigation or an investigation is anticipated. One of the purposes of… - GETGet case
/v2/orgs/:org_id/cases/:case_idRetrieves information about a case in an organization.<br/><h3>Required scope</h3> <a target=_blank… - PUTEdit case
/v2/orgs/:org_id/cases/:case_idEditing a case allows eDiscovery Admins to keep case details accurate and aligned with the evolving scope of a legal matter. As investigations progress, it… - DELETEClose case
/v2/orgs/:org_id/cases/:case_idClosing a case is the final stage in the eDiscovery process, marking the conclusion of a legal matter or investigation. You must ensure that all associated… - GETGet all legal holds within a case
/v2/orgs/:org_id/cases/:case_id/legal-holdsRetrieves the list of all legal holds within a case for an organization.<br/><h3>Required scope</h3> <a target=_blank… - POSTCreate legal hold
/v2/orgs/:org_id/cases/:case_id/legal-holdsAfter creating a case it is possible to add one or multiple legal holds to the case. Creating a legal hold involves identifying the relevant users associated… - GETGet board export jobs of a case
/v2/orgs/:org_id/cases/:case_id/export-jobsRetrieves board export jobs for a case.<br/><h3>Required scope</h3> <a target=_blank… - GETGet legal hold information
/v2/orgs/:org_id/cases/:case_id/legal-holds/:legal_hold_idRetrieves information about a legal hold within a case for an organization. <br/><h3>Required scope</h3> <a target=_blank… - PUTEdit legal hold
/v2/orgs/:org_id/cases/:case_id/legal-holds/:legal_hold_idEditing a legal hold allows eDiscovery Admins to adjust and refine ongoing legal preservation efforts as case requirements evolve. Whether new custodians are… - DELETEClose legal hold
/v2/orgs/:org_id/cases/:case_id/legal-holds/:legal_hold_idClosing a legal hold is one of the final steps in the eDiscovery process once the litigation or investigation has concluded. This process involves releasing… - GETGet content items under legal hold
/v2/orgs/:org_id/cases/:case_id/legal-holds/:legal_hold_id/content-itemsOnce a legal hold is in place you can review or explore the preserved Miro boards to ensure that all relevant data is intact and ready for legal proceedings…
Board Export
- GETGet board export jobs list
/v2/orgs/:org_id/boards/export/jobsRetrieves the list of board export jobs based on the filters provided in the request.<br/><h3>Required scope</h3> <a target=_blank… - POSTCreate board export job
/v2/orgs/:org_id/boards/export/jobs?request_id=92343229-c532-446d-b8cb-2f155bedb807Creates an export job for one or more boards.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:export</a>… - GETGet board export job status
/v2/orgs/:org_id/boards/export/jobs/:job_idRetrieves the status of the board export job.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:export</a>… - GETGet results for board export job
/v2/orgs/:org_id/boards/export/jobs/:job_id/resultsRetrieves the result of the board export job. The response provides more information about the board export job, such as the S3 link to the files… - PUTUpdate board export job status
/v2/orgs/:org_id/boards/export/jobs/:job_id/statusUpdates the status of the board export job.<br/>Currently, only the cancellation of an ongoing export job is supported.<br/><h3>Required scope</h3> <a… - GETGet board export job tasks list
/v2/orgs/:org_id/boards/export/jobs/:job_id/tasksRetrieves the list of tasks for the board export job.<br/><h3>Required scope</h3> <a target=_blank… - POSTCreate task export link
/v2/orgs/:org_id/boards/export/jobs/:job_id/tasks/:task_id/export-linkCreates a link to download the results of a board export task.<br/><h3>Required scope</h3> <a target=_blank…
Board Content Logs
- GETRetrieve content change logs of board items
/v2/orgs/:org_id/content-logs/items?from=2022-03-30T17:26:50Z&to=2023-03-30T17:26:50ZRetrieves content changes for board items within your organization. Content changes are actions that users can perform on board items, such as updating a…
Reset all sessions of a user
- POSTReset all sessions of a user
/v2/sessions/reset_all?email=john.smith@example.comReset all sessions of a user. Admins can now take immediate action to restrict user access to company data in case of security concerns. Calling this API ends…
User
- GETList users
/UsersRetrieves the list of users in your organization. <br><b> <br>Note</b>: The API returns users that are members in the organization, it does not return users… - POSTCreate user
/UsersCreates a new user in the organization. <br><br> <br>Note</b>: All newly provisioned users are added to the default team. - GETGet user
/Users/:idRetrieves a single user resource. <br><b> <br>Note</b>: Returns only users that are members in the organization. It does not return users that are added in… - PUTReplace user
/Users/:idUpdates an existing user resource. This is the easiest way to replace user information. <br><br> If the user is deactivated, <br> userName, userType, and… - DELETEDelete user
/Users/:idDeletes a single user from the organization.<br><br> Note: A user who is the last admin in the team or the last admin in the organization cannot be deleted.… - PATCHPatch user
/Users/:idUpdates an existing user resource, overwriting values for specified attributes. Attributes that are not provided will remain unchanged. PATCH operation only…
Group
- GETList groups
/GroupsRetrieves the list of groups (teams) in the organization.<br><br> Note: Along with groups (teams), the users that are part of those groups (teams) are also… - GETGet group
/Groups/:idRetrieves a single Group resource.<br><b> Note</b>: Along with groups (teams), the users that are part of those groups (teams) are also retrieved. Only users… - PATCHPatch group
/Groups/:idUpdates an existing group resource, i.e. a team, overwriting values for specified attributes. Patch operation for group can be used to add, remove, or replace…
Discovery
- GETGet Service Provider Config
/ServiceProviderConfigRetrieve supported operations and SCIM API basic configuration. - GETList resource types
/ResourceTypesRetrieve information about which SCIM resources are supported. <br><br> Currently, Miro supports Users and Groups as Resource Types. - GETGet resource type
/ResourceTypes/:resourceRetrieve metadata for the available resource types (User and Group) that are supported. - GETList schemas
/SchemasRetrieve metadata about Users, Groups, and extension attributes that are currently supported. - GETGet schema
/Schemas/:uriRetrieve information about how users, groups, and enterprise-user attributes URIs that are formatted.
Organizations
- GETGet organization info
/v2/orgs/:org_idRetrieves organization information.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>organizations:read</a>…
Organization Members
- GETGet organization members
/v2/orgs/:org_id/membersRetrieves organization members based on the organization ID and the cursor, or based on the user emails provided in the request.<br/><h3>Required scope</h3>… - GETGet organization member
/v2/orgs/:org_id/members/:member_idRetrieves organization member information for an existing organization.<br/><h3>Required scope</h3> <a target=_blank…
Boards
- GETGet boards
/v2/boardsRetrieves a list of boards accessible to the user associated with the provided access token. This endpoint supports filtering and sorting through URL query… - PUTCopy board
/v2/boards?copy_from=stringCreates 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… - POSTCreate board
/v2/boardsCreates 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… - GETGet specific board
/v2/boards/:board_idRetrieves information about a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:read</a>… - DELETEDelete board
/v2/boards/:board_idDeletes 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… - PATCHUpdate board
/v2/boards/:board_idUpdates a specific board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a> <br/><h3>Rate…
App card items
- POSTCreate app card item
/v2/boards/:board_id/app_cardsAdds an app card item to a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>… - GETGet app card item
/v2/boards/:board_id/app_cards/:item_idRetrieves information for a specific app card item on a board.<br/><h3>Required scope</h3> <a target=_blank… - DELETEDelete app card item
/v2/boards/:board_id/app_cards/:item_idDeletes an app card item from a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>… - PATCHUpdate app card item
/v2/boards/:board_id/app_cards/:item_idUpdates 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…
Card items
- POSTCreate card item
/v2/boards/:board_id/cardsAdds a card item to a board<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a> <br/><h3>Rate… - GETGet card item
/v2/boards/:board_id/cards/:item_idRetrieves information for a specific card item on a board<br/><h3>Required scope</h3> <a target=_blank… - DELETEDelete card item
/v2/boards/:board_id/cards/:item_idDeletes a card item from the board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>… - PATCHUpdate card item
/v2/boards/:board_id/cards/:item_idUpdates 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…
Connectors
- GETGet connectors
/v2/boards/:board_id/connectorsRetrieves 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… - POSTCreate connector
/v2/boards/:board_id/connectorsAdds a connector to a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a> <br/><h3>Rate… - GETGet specific connector
/v2/boards/:board_id/connectors/:connector_idRetrieves information for a specific connector on a board.<br/><h3>Required scope</h3> <a target=_blank… - DELETEDelete connector
/v2/boards/:board_id/connectors/:connector_idDeletes the specified connector from the board.<br/><h3>Required scope</h3> <a target=_blank… - PATCHUpdate connector
/v2/boards/:board_id/connectors/:connector_idUpdates 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…
Document items
- POSTCreate document item using URL
/v2/boards/:board_id/documentsAdds a document item to a board by specifying the URL where the document is hosted.<br/><h3>Required scope</h3> <a target=_blank… - GETGet document item
/v2/boards/:board_id/documents/:item_idRetrieves information for a specific document item on a board<br/><h3>Required scope</h3> <a target=_blank… - DELETEDelete document item
/v2/boards/:board_id/documents/:item_idDeletes a document item from the board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>… - PATCHUpdate document item using URL
/v2/boards/:board_id/documents/:item_idUpdates a document item on a board<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>…
Embed items
- POSTCreate embed item
/v2/boards/:board_id/embedsAdds an embed item containing external content to a board.<br/><h3>Required scope</h3> <a target=_blank… - GETGet embed item
/v2/boards/:board_id/embeds/:item_idRetrieves information for a specific embed item on a board.<br/><h3>Required scope</h3> <a target=_blank… - DELETEDelete embed item
/v2/boards/:board_id/embeds/:item_idDeletes an embed item from the board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>… - PATCHUpdate embed item
/v2/boards/:board_id/embeds/:item_idUpdates an embed item on a board based on the data properties provided in the request body.<br/><h3>Required scope</h3> <a target=_blank…
Image items
- POSTCreate image item using URL
/v2/boards/:board_id/imagesAdds an image item to a board by specifying an image URL.<br/><h3>Required scope</h3> <a target=_blank… - GETGet image item
/v2/boards/:board_id/images/:item_idRetrieves information for a specific image item on a board.<br/><h3>Required scope</h3> <a target=_blank… - DELETEDelete image item
/v2/boards/:board_id/images/:item_idDeletes an image item from the board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>… - PATCHUpdate image item using URL
/v2/boards/:board_id/images/:item_idUpdates an image item on a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>…
Items
- GETGet items on board
/v2/boards/:board_id/itemsRetrieves 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… - GETGet specific item on board
/v2/boards/:board_id/items/:item_idRetrieves information for a specific item on a board.<br/><h3>Required scope</h3> <a target=_blank… - DELETEDelete item
/v2/boards/:board_id/items/:item_idDeletes an item from a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a> <br/><h3>Rate… - PATCHUpdate item position or parent
/v2/boards/:board_id/items/:item_idUpdates the position or the parent of an item on a board.<br/><h3>Required scope</h3> <a target=_blank…
Board members
- GETGet all board members
/v2/boards/:board_id/membersRetrieves a pageable list of members for a board.<br/><h3>Required scope</h3> <a target=_blank… - POSTShare board
/v2/boards/:board_id/membersShares 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… - GETGet specific board member
/v2/boards/:board_id/members/:board_member_idRetrieves information for a board member.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:read</a>… - DELETERemove board member
/v2/boards/:board_id/members/:board_member_idRemoves a board member from a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>… - PATCHUpdate board member
/v2/boards/:board_id/members/:board_member_idUpdates the role of a board member.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>…
Shape items
- POSTCreate shape item
/v2/boards/:board_id/shapesAdds a shape item to a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a> <br/><h3>Rate… - GETGet shape item
/v2/boards/:board_id/shapes/:item_idRetrieves information for a specific shape item on a board.<br/><h3>Required scope</h3> <a target=_blank… - DELETEDelete shape item
/v2/boards/:board_id/shapes/:item_idDeletes a shape item from the board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>… - PATCHUpdate shape item
/v2/boards/:board_id/shapes/:item_idUpdates 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…
Sticky note items
- POSTCreate sticky note item
/v2/boards/:board_id/sticky_notesAdds a sticky note item to a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>… - GETGet sticky note item
/v2/boards/:board_id/sticky_notes/:item_idRetrieves information for a specific sticky note item on a board.<br/><h3>Required scope</h3> <a target=_blank… - DELETEDelete sticky note item
/v2/boards/:board_id/sticky_notes/:item_idDeletes a sticky note item from the board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>… - PATCHUpdate sticky note item
/v2/boards/:board_id/sticky_notes/:item_idUpdates 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…
Text items
- POSTCreate text item
/v2/boards/:board_id/textsAdds a text item to a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a> <br/><h3>Rate… - GETGet text item
/v2/boards/:board_id/texts/:item_idRetrieves information for a specific text item on a board.<br/><h3>Required scope</h3> <a target=_blank… - DELETEDelete text item
/v2/boards/:board_id/texts/:item_idDeletes a text item from the board<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>… - PATCHUpdate text item
/v2/boards/:board_id/texts/:item_idUpdates 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…
Bulk operations
- POSTCreate items in bulk
/v2/boards/:board_id/items/bulkAdds different types of items to a board. You can add up to 20 items of the same or different type per create call. For example, you can create 3 shape items,… - POSTCreate items in bulk using file from device
/v2/boards/:board_id_Platformcreateitemsinbulkusingfilefromdevice/items/bulkAdds different types of items to a board using files from a device. You can add up to 20 items of the same or different type per create call. For example, you…
frames
- POSTCreate frame
/v2/boards/:board_id/framesAdds a frame to a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a> <br/><h3>Rate… - GETGet frame
/v2/boards/:board_id/frames/:item_idRetrieves information for a specific frame on a board.<br/><h3>Required scope</h3> <a target=_blank… - DELETEDelete frame
/v2/boards/:board_id/frames/:item_idDeletes a frame from a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a> <br/><h3>Rate… - PATCHUpdate frame
/v2/boards/:board_id/frames/:item_idUpdates a frame on a board based on the data, style, or geometry properties provided in the request body.<br/><h3>Required scope</h3> <a target=_blank…
items
- GETGet items within frame
/v2/boards/:board_id_PlatformContainers/items?parent_item_id=stringRetrieves a list of items within a specific frame. A frame is a parent item and all items within a frame are child items. This method returns results using a… - DELETEDelete item
/v2-experimental/boards/:board_id/items/:item_idDeletes an item from a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a> <br/><h3>Rate…
App metrics (experimental)
- GETGet app metrics
/v2-experimental/apps/:app_id/metrics?startDate=2024-01-01&endDate=2024-01-01Returns a list of usage metrics for a specific app for a given time range, grouped by requested time period. This endpoint requires an app management API… - GETGet total app metrics
/v2-experimental/apps/:app_id/metrics-totalReturns total usage metrics for a specific app since the app was created. This endpoint requires an app management API token. It can be generated in <a…
Mind map nodes (experimental)
- GETGet specific mind map node
/v2-experimental/boards/:board_id/mindmap_nodes/:item_idRetrieves information for a specific mind map node on a board.<br/><h3>Required scope</h3> <a target=_blank… - DELETEDelete mind map node
/v2-experimental/boards/:board_id/mindmap_nodes/:item_idDeletes a mind map node item and its child nodes from the board.<br/><h3>Required scope</h3> <a target=_blank… - GETGet mind map nodes
/v2-experimental/boards/:board_id/mindmap_nodesRetrieves a list of mind map nodes for a specific board. This method returns results using a cursor-based approach. A cursor-paginated method returns a… - POSTCreate mind map node
/v2-experimental/boards/:board_id/mindmap_nodesAdds a mind map node to a board. A root node is the starting point of a mind map. A node that is created under a root node is a child node. For information on…
Flowchart shapes (experimental)
- GETGet items on board
/v2-experimental/boards/:board_id/itemsRetrieves 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… - GETGet specific item on board
/v2-experimental/boards/:board_id/items/:item_idRetrieves information for a specific item on a board.<br/><h3>Required scope</h3> <a target=_blank… - POSTCreate shape item
/v2-experimental/boards/:board_id/shapesAdds a flowchart shape item to a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>… - GETGet shape item
/v2-experimental/boards/:board_id/shapes/:item_idRetrieves information for a specific shape item on a board.<br/><h3>Required scope</h3> <a target=_blank… - DELETEDelete shape item
/v2-experimental/boards/:board_id/shapes/:item_idDeletes a flowchart shape item from the board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>… - PATCHUpdate shape item
/v2-experimental/boards/:board_id/shapes/:item_idUpdates a flowchart 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…
Code widget items (experimental)
- GETGet code widget items
/v2-experimental/boards/:board_id/code_widgetsRetrieves a list of code widget items for a specific board. This method returns results using a cursor-based approach. A cursor-paginated method returns a… - POSTCreate code widget item
/v2-experimental/boards/:board_id/code_widgetsAdds a code widget item to a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>… - GETGet code widget item
/v2-experimental/boards/:board_id/code_widgets/:item_idRetrieves information for a specific code widget item on a board.<br/><h3>Required scope</h3> <a target=_blank… - DELETEDelete code widget item
/v2-experimental/boards/:board_id/code_widgets/:item_idDeletes a code widget item from the board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>… - PATCHUpdate code widget item
/v2-experimental/boards/:board_id/code_widgets/:item_idUpdates a code widget item on a board based on the data properties provided in the request body.<br/><h3>Required scope</h3> <a target=_blank… - PATCHMove code widget item
/v2-experimental/boards/:board_id/code_widgets/:item_id/positionUpdates the position of a code widget item on a board.<br/><h3>Required scope</h3> <a target=_blank…
documents
- POSTCreate document item using file from device
/v2/boards/:board_id_PlatformFileUpload/documentsAdds a document item to a board by selecting file from device.<br/><h3>Required scope</h3> <a target=_blank… - PATCHUpdate document item using file from device
/v2/boards/:board_id_PlatformFileUpload/documents/:item_idUpdates a document item on a board by using file from a device.<br/><h3>Required scope</h3> <a target=_blank…
images
- POSTCreate image item using file from device
/v2/boards/:board_id_PlatformFileUpload/imagesAdds an image item to a board by specifying a file from device.<br/><h3>Required scope</h3> <a target=_blank… - PATCHUpdate image item using file from device
/v2/boards/:board_id_PlatformFileUpload/images/:item_idUpdates an image item on a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>…
groups
- GETGet all groups on a board
/v2/boards/:board_id/groupsReturns all the groups and the items of the respective groups within a specific board.<br/> This method returns results using a cursor-based approach. A… - POSTCreate group
/v2/boards/:board_id/groupsCreates a group of items on a board. The group is created with the items that are passed in the request body.<br/><h3>Required scope</h3> <a target=_blank… - GETGet items of a group by ID
/v2/boards/:board_id/groups/items?group_item_id=stringReturns a list of items that are a part of any group, within a specific board.<br/> This method returns results using a cursor-based approach. A… - GETGet a group by its ID
/v2/boards/:board_id/groups/:group_idReturns a list of items in a specific group. <br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:read</a>… - PUTUpdates a group with new items
/v2/boards/:board_id/groups/:group_idThis endpoint updates an existing group by replacing it entirely with a new group. When the update is made, the original group is completely replaced, and a… - DELETEUngroup items
/v2/boards/:board_id/groups/:group_idUngroups items from a group.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a> <br/><h3>Rate… - DELETEDeletes the group
/v2/boards/:board_id/groups/:group_id??delete_items=trueDeletes a group from a board. All the items in the group are deleted along with the group. <b>Note - this endpoint will delete items which are locked as well.…
OAuth
- POSTRevoke token (v2)
/v2/oauth/revokeRevoke the current access token. Revoking an access token means that the access token will no longer work. When an access token is revoked, the refresh token…
tags
- GETGet tags from item
/v2/boards/:board_id/items/:item_id/tagsRetrieves all the tags from the specified item.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:read</a>… - GETGet tags from board
/v2/boards/:board_id/tagsRetrieves all the tags from the specified board.<br/><h3>Required scope</h3> <a target=_blank… - POSTCreate tag
/v2/boards/:board_id/tagsCreates a tag on a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a> <br/><h3>Rate… - GETGet tag
/v2/boards/:board_id/tags/:tag_idRetrieves information for a specific tag.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>… - DELETEDelete tag
/v2/boards/:board_id/tags/:tag_idDeletes the specified tag from the board. The tag is also removed from all cards and sticky notes on the board. <br><blockquote><strong>Note:</strong> Updates… - PATCHUpdate tag
/v2/boards/:board_id/tags/:tag_idUpdates a tag based on the data properties provided in the request body. <br><blockquote><strong>Note:</strong> Updates to tags made via the REST API will not… - GETGet items by tag
/v2/boards/:board_id_PlatformTags/items?tag_id=stringRetrieves all the items that have the specified tag.<br/><h3>Required scope</h3> <a target=_blank… - POSTAttach tag to item
/v2/boards/:board_id_PlatformTags/items/:item_id?tag_id=stringAttach an existing tag to the specified item. Card and sticky note items can have up to 8 tags. <br><blockquote><strong>Note:</strong> Updates to tags made… - DELETERemove tag from item
/v2/boards/:board_id_PlatformTags/items/:item_id?tag_id=stringRemoves the specified tag from the specified item. The tag still exists on the board. <br><blockquote><strong>Note:</strong> Updates to tags made via the REST…
Projects
- GETList of projects
/v2/orgs/:org_id/teams/:team_id/projectsRetrieves the list of projects in an existing team of an organization. You can retrieve all projects, including all private projects (projects that haven't… - POSTCreate project
/v2/orgs/:org_id/teams/:team_id/projectsProjects are essentially folders of boards with the option to manage user access for a smaller group of people within a team. Projects are here to help you… - GETGet project
/v2/orgs/:org_id/teams/:team_id/projects/:project_idRetrieves project information, such as a name for an existing project.<h4>Note</h4> <em>Projects</em> have been renamed to <em>Spaces</em>, and the terms can… - DELETEDelete project
/v2/orgs/:org_id/teams/:team_id/projects/:project_idDeletes a project. After a project is deleted, all boards and users that belong to the project remain in the team.<h4>Note</h4> <em>Projects</em> have been… - PATCHUpdate project
/v2/orgs/:org_id/teams/:team_id/projects/:project_idUpdate information about a project, such as the project name.<h4>Note</h4> <em>Projects</em> have been renamed to <em>Spaces</em>, and the terms can be used…
Project Settings
- GETGet project settings
/v2/orgs/:org_id/teams/:team_id/projects/:project_id/settingsRetrieves the project settings.<h4>Note</h4> <em>Projects</em> have been renamed to <em>Spaces</em>, and the terms can be used interchangeably.<h3>Required… - PATCHUpdate project settings
/v2/orgs/:org_id/teams/:team_id/projects/:project_id/settingsUpdates the settings of a project.<h4>Note</h4> <em>Projects</em> have been renamed to <em>Spaces</em>, and the terms can be used interchangeably.<h3>Required…
Project Members
- GETList of project members
/v2/orgs/:org_id/teams/:team_id/projects/:project_id/membersRetrieves the list of members for a specific project.<h4>Note</h4> <em>Projects</em> have been renamed to <em>Spaces</em>, and the terms can be used… - POSTAdd member in a project
/v2/orgs/:org_id/teams/:team_id/projects/:project_id/membersAdd a Miro user to a project.<h4>Note</h4> <em>Projects</em> have been renamed to <em>Spaces</em>, and the terms can be used interchangeably.<h3>Required… - GETGet project member
/v2/orgs/:org_id/teams/:team_id/projects/:project_id/members/:member_idRetrieves information for a specific project member.<h4>Note</h4> <em>Projects</em> have been renamed to <em>Spaces</em>, and the terms can be used… - DELETERemove project member
/v2/orgs/:org_id/teams/:team_id/projects/:project_id/members/:member_idRemove a member from a project. The user remains in the team even after the member is removed from a project.<h4>Note</h4> <em>Projects</em> have been renamed… - PATCHUpdate project member
/v2/orgs/:org_id/teams/:team_id/projects/:project_id/members/:member_idUpdates details of a project member, such as the member's role.<h4>Note</h4> <em>Projects</em> have been renamed to <em>Spaces</em>, and the terms can be used…
Teams
- GETList teams
/v2/orgs/:org_id/teamsRetrieves list of teams in an existing organization.<br/><h3>Required scope</h3> <a target=_blank… - POSTCreate team
/v2/orgs/:org_id/teamsCreates a new team in an existing organization.<br/><h3>Required scope</h3> <a target=_blank… - GETGet team
/v2/orgs/:org_id/teams/:team_idRetrieves team information for an existing team.<br/><h3>Required scope</h3> <a target=_blank… - DELETEDelete team
/v2/orgs/:org_id/teams/:team_idDeletes an existing team.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>organizations:teams:write</a>… - PATCHUpdate team
/v2/orgs/:org_id/teams/:team_idUpdates an existing team.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>organizations:teams:write</a>…
Team Members
- GETList team members
/v2/orgs/:org_id/teams/:team_id/membersRetrieves team members by cursor.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>organizations:teams:read</a>… - POSTInvite team members
/v2/orgs/:org_id/teams/:team_id/membersInvites a new Miro user to an existing team. The user must exist in your Miro organization. Users who do not exist in your Miro organization can be invited to… - GETGet team member
/v2/orgs/:org_id/teams/:team_id/members/:member_idRetrieves team member by id.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>organizations:teams:read</a>… - DELETEDelete team member from team
/v2/orgs/:org_id/teams/:team_id/members/:member_idDeletes team member from team by id.<br/><h3>Required scope</h3> <a target=_blank… - PATCHUpdate team member
/v2/orgs/:org_id/teams/:team_id/members/:member_idUpdates team member role in team by id.<br/><h3>Required scope</h3> <a target=_blank…
Team Settings
- GETGet default team settings
/v2/orgs/:org_id/default_teams_settingsRetrieves default team settings of an existing organization.<br/><h3>Required scope</h3> <a target=_blank… - GETGet team settings
/v2/orgs/:org_id/teams/:team_id/settingsRetrieves team settings of an existing team.<br/><h3>Required scope</h3> <a target=_blank… - PATCHUpdate team settings
/v2/orgs/:org_id/teams/:team_id/settingsUpdates team settings of an existing team.<br/><h3>Required scope</h3> <a target=_blank…
User groups
- GETList of user groups
/v2/orgs/:org_id/groupsRetrieves the list of user groups in an organization.<br/><h3>Required scope</h3> <a target=_blank… - POSTCreate user group
/v2/orgs/:org_id/groupsCreates a new user group in an organization.<br/><h3>Required scope</h3> <a target=_blank… - GETGet user group
/v2/orgs/:org_id/groups/:group_idRetrieves a user group in an organization.<br/><h3>Required scope</h3> <a target=_blank… - DELETEDelete user group
/v2/orgs/:org_id/groups/:group_idDeletes a user group from an organization.<br/><h3>Required scope</h3> <a target=_blank… - PATCHUpdate user group
/v2/orgs/:org_id/groups/:group_idUpdates a user group in an organization.<br/><h3>Required scope</h3> <a target=_blank…
User group members
- GETList of user group members
/v2/orgs/:org_id/groups/:group_id/membersRetrieves the list of members who are part of a team in an existing organization.<br/> <h3>Required scope</h3> <a target=_blank… - POSTCreate user group member
/v2/orgs/:org_id/groups/:group_id/membersAdds a member to a user group in an organization.<br/> <h3>Required scope</h3> <a target=_blank… - PATCHBulk edit of membership in user group
/v2/orgs/:org_id/groups/:group_id/membersAdd and remove members in one request. For example, remove user A and add user B. You can add or remove up to 500 users at a time.<br/> <h3>Required… - GETGet user group member
/v2/orgs/:org_id/groups/:group_id/members/:member_idRetrieves information about a user group member in an organization.<br/> <h3>Required scope</h3> <a target=_blank… - DELETEDelete user group member
/v2/orgs/:org_id/groups/:group_id/members/:member_idRemoves a member from a user group in an organization.<br/> <h3>Required scope</h3> <a target=_blank…
User group to teams
- GETGet teams of a user group
/v2/orgs/:org_id/groups/:group_id/teamsRetrieves the list of teams that the user group is a part of.<br/><h3>Required scope</h3> <a target=_blank… - GETGet user group team
/v2/orgs/:org_id/groups/:group_id/teams/:team_idRetrieves information of a team that the user group is a part of in an organization.<br/><h3>Required scope</h3> <a target=_blank…
Team user groups
- GETList of user group to team connections
/v2/orgs/:org_id/teams/:team_id/groupsRetrieves the list of user groups that are part of a team in an organization.<br/> <h3>Required scope</h3> <a target=_blank… - POSTCreate user group to team connection
/v2/orgs/:org_id/teams/:team_id/groupsAdds a user group to a team in an organization.<br/> <h3>Required scope</h3> <a target=_blank… - GETGet user group of a team
/v2/orgs/:org_id/teams/:team_id/groups/:group_idRetrieves information about a specific user group of a team.<br/> <h3>Required scope</h3> <a target=_blank… - DELETEDelete user group to team connection
/v2/orgs/:org_id/teams/:team_id/groups/:group_idRemoves a user group from a team in an existing organization.<br/> <h3>Required scope</h3> <a target=_blank…
Share boards with groups
- GETGet board user group assignments
/v2/orgs/:org_id/boards/:board_id/groupsRetrieves information about user groups invited to the specified board.<br/> <h3>Required scope</h3> <a target=_blank… - POSTCreate board user group assignments
/v2/orgs/:org_id/boards/:board_id/groupsShares a board with user groups with a specified role. Updates the role if already shared.<br/> <h3>Required scope</h3> <a target=_blank… - DELETEDelete board user group assignment
/v2/orgs/:org_id/boards/:board_id/groups/:group_idRemoves a user group from the specified board.<br/> <h3>Required scope</h3> <a target=_blank…
Share projects with groups
- GETGet project user group assignments
/v2/orgs/:org_id/projects/:project_id/groupsRetrieves information about user groups invited to the specified project.<br/> <h3>Required scope</h3> <a target=_blank… - POSTCreate project user group assignments
/v2/orgs/:org_id/projects/:project_id/groupsShares a project with user groups with a specified role. Updates the role if already shared.<br/> <h3>Required scope</h3> <a target=_blank… - DELETEDelete project user group assignment
/v2/orgs/:org_id/projects/:project_id/groups/:group_idRemoves a user group from the specified project.<br/> <h3>Required scope</h3> <a target=_blank…
API details
- Base URL
https://api.miro.com- Authentication
- OAuth 2.0 (authorization code flow) with 8 scopes
- Operations
- 197 operations on 114 pathsGET 85POST 41DELETE 34PATCH 31PUT 6
1 marked deprecated - Main resources
- Legal holds 12tags 9Board Export 7groups 7Boards 6Code widget items (experimental) 6Flowchart shapes (experimental) 6User 6Board members 5Connectors 5
- Response formats
application/jsonapplication/scim+json- Description format
- OpenAPI 3.0.1, API version
v2.0 - Links
- OpenAPI document
- Listed from
- Miro's published OpenAPI description (miroapp/api-clients) (MIT)
How to test the Miro REST API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Miro REST API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 8 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Revoke token (v1)” (POST /v1/oauth/revoke?access_token=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Miro REST API?
Miro Developer Platform concepts New to the Miro Developer Platform? Interested in learning more about platform concepts?? [Read our introduction… It is listed under Productivity & workspace and has 197 endpoints.
Who publishes the Miro REST API?
It is listed from Miro's public API description (an OpenAPI document), not published by Miro on Swastik Codes. Anyone who controls miro.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Miro REST API?
Requests go to https://api.miro.com. Endpoint paths are added to this base URL.
How do I authenticate with the Miro REST API?
With OAuth 2.0 (authorization code flow) with 8 scopes.
How many endpoints does the Miro REST API have?
197 operations on 114 paths (85 GET, 41 POST, 34 DELETE, 31 PATCH, 6 PUT). The largest groups are Legal holds, tags, Board Export, groups.
Is forking the Miro REST API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.