KosmoKrator

productivity

Miro MCP, CLI, and Lua Integration for AI Agents

Miro integration docs for AI agents: MCP gateway setup, Miro CLI commands, Lua API reference, credentials, and function schemas.

Miro for agents

Credentials can be configured manually in web or CLI hosts.

Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.

Agent Surfaces

Miro CLIHeadless setup, JSON output, direct function calls. Miro MCPExpose selected tools to local MCP clients. Miro LuaAgent-facing namespace and Lua reference. FeedbackReport missing tools, auth issues, or bad metadata.

Machine-Readable Metadata

integration_slug
miro
route_slug
miro
package
miro
auth_strategy
oauth_bearer_token
cli_setup_supported
true
cli_runtime_supported
true
mcp_gateway_supported
true
lua_supported
true

Function Catalog

FunctionTypeParametersDescription
miro.miro_revoke_token Write write 0 Please use the new revoke endpoint /v2/oauth/revoke. This endpoint is considered vulnerable and deprecated due to access token passed publicly in the URL. Revoke the current access token. Revoking an access token means that the access token will no longer work
miro.miro_token_info Read read 0 Get 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. Official Miro endpoint: GET /v1/oauth-token.
miro.miro_enterprise_get_ai_interaction_logs Read read 0 Retrieves AI interaction logs for your organization. AI interaction logs capture user interactions with AI features in Miro. You can retrieve results for a specific time period. You can also filter results based on object IDs and the emails of users who intera
miro.miro_enterprise_get_audit_logs Read read 0 Retrieves 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 CSV export feature. Required scope auditlogs:read Rate limiting Level 2 Official Miro endpoint: GET /v2/audit/logs.
miro.miro_enterprise_dataclassification_organization_settings_get Read read 0 Retrieves board classification settings for an existing organization. Required scope organizations:read Rate limiting Level 2 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company
miro.miro_enterprise_dataclassification_team_boards_bulk Write write 0 Updates board classification for not-classified only or all boards in an existing team. Required scope boards:write Rate limiting Level 4 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role
miro.miro_enterprise_dataclassification_team_settings_get Read read 0 Retrieves board classification settings for an existing team. Required scope organizations:teams:read Rate limiting Level 2 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company A
miro.miro_enterprise_dataclassification_team_settings_set Write write 0 Updates board classification settings for an existing team. Required scope organizations:teams:write Rate limiting Level 2 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Ad
miro.miro_enterprise_dataclassification_board_get Read read 0 Retrieves board classification for a board. Required scope boards:read Rate limiting Level 2 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary
miro.miro_enterprise_dataclassification_board_set Write write 0 Updates board classification for an existing board. Required scope boards:write Rate limiting Level 2 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request
miro.miro_create_doc_format_item Write write 0 Adds a doc format item to a board. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: POST /v2/boards/{board_id}/docs.
miro.miro_get_doc_format_item Read read 0 Retrieves information for a specific doc format item on a board. Required scope boards:read Rate limiting Level 1 Official Miro endpoint: GET /v2/boards/{board_id}/docs/{item_id}.
miro.miro_delete_doc_format_item Write write 0 Deletes a doc format item from the board Required scope boards:write Rate limiting Level 3 Official Miro endpoint: DELETE /v2/boards/{board_id}/docs/{item_id}.
miro.miro_get_all_cases Read read 0 Retrieves the list of eDiscovery cases in an organization. Required scope organization:cases:management Rate limiting Level 4 Enterprise Guard only This API is available only for Enterprise plan users with the Enterprise Guard add-on. You can only use this end
miro.miro_create_case Write write 0 Creating 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 creating a case is that it acts as a container that allows admins to group multiple legal holds under
miro.miro_delete_case Write write 0 Closing 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 legal holds within the case are closed before closing the case. Closing a case will permanently delete i
miro.miro_get_case Read read 0 Retrieves information about a case in an organization. Required scope organization:cases:management Rate limiting Level 3 Enterprise Guard only This API is available only for Enterprise plan users with the Enterprise Guard add-on. You can only use this endpoin
miro.miro_edit_case Write write 0 Editing a case allows eDiscovery Admins to keep case details accurate and aligned with the evolving scope of a legal matter. As investigations progress, it may be necessary to update the case name or description to reflect changes in focus, terminology, or int
miro.miro_get_all_legal_holds Read read 0 Retrieves the list of all legal holds within a case for an organization. Required scope organization:cases:management Rate limiting Level 4 Enterprise Guard only This API is available only for Enterprise plan users with the Enterprise Guard add-on. You can onl
miro.miro_create_legal_hold Write write 0 After 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 with a case and applying the hold to prevent permanent deletion of content that those users own, co-ow
miro.miro_get_legal_hold_export_jobs Read read 0 Retrieves board export jobs for a case. Required scope organization:cases:management Rate limiting Level 4 Enterprise Guard only This API is available only for Enterprise plan users with the Enterprise Guard add-on. You can only use this endpoint if you have b
miro.miro_delete_legal_hold Write write 0 Closing a legal hold is one of the final steps in the eDiscovery process once the litigation or investigation has concluded. This process involves releasing the Miro boards and custodians that were under legal hold, allowing the preserved boards to return to n
miro.miro_get_legal_hold Read read 0 Retrieves information about a legal hold within a case for an organization. Required scope organization:cases:management Rate limiting Level 3 Enterprise Guard only This API is available only for Enterprise plan users with the Enterprise Guard add-on. You can
miro.miro_edit_legal_hold Write write 0 Editing a legal hold allows eDiscovery Admins to adjust and refine ongoing legal preservation efforts as case requirements evolve. Whether new custodians are identified, additional Miro boards become relevant, or existing boards or users are no longer in scope
miro.miro_get_legal_hold_content_items Read read 0 Once 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 or investigations. For more information, see our Help Center page on reviewing boards under legal hold.
miro.miro_enterprise_create_board_export Write write 0 Creates an export job for one or more boards. Required scope boards:export Rate limiting Level 4 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin and eDiscovery is enab
miro.miro_enterprise_board_export_jobs Read read 0 Retrieves the list of board export jobs based on the filters provided in the request. Required scope boards:export Rate limiting Level 4 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role o
miro.miro_enterprise_board_export_job_status Read read 0 Retrieves the status of the board export job. Required scope boards:export Rate limiting Level 4 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin and eDiscovery is enab
miro.miro_enterprise_board_export_job_results Read read 0 Retrieves 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 created. Required scope boards:export Rate limiting Level 4 Enterprise only This API is available only for Enterpr
miro.miro_enterprise_update_board_export_job Write write 0 Updates the status of the board export job. Currently, only the cancellation of an ongoing export job is supported. Required scope boards:export Rate limiting Level 4 Enterprise only This API is available only for Enterprise plan users. You can only use this e
miro.miro_enterprise_board_export_job_tasks Read read 0 Retrieves the list of tasks for the board export job. Required scope boards:export Rate limiting Level 4 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin and eDiscovery
miro.miro_enterprise_create_board_export_task_export_link Write write 0 Creates a link to download the results of a board export task. Required scope boards:export Rate limiting Level 4 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin and e
miro.miro_enterprise_board_content_item_logs_fetch Read read 0 Retrieves content changes for board items within your organization. Content changes are actions that users can perform on board items, such as updating a sticky note's text. You can retrieve results for a specific time period. You can also filter results based
miro.miro_enterprise_post_user_sessions_reset Write write 0 Reset 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 all active Miro sessions across devices for a particular user, requiring the user to sign in again. T
miro.miro_list_users Read read 0 Retrieves the list of users in your organization. Note: The API returns users that are members in the organization, it does not return users that are added in the organization as guests. Official Miro endpoint: GET /Users.
miro.miro_create_user Write write 0 Creates a new user in the organization. Note: All newly provisioned users are added to the default team. Official Miro endpoint: POST /Users.
miro.miro_get_user Read read 0 Retrieves a single user resource. Note: Returns only users that are members in the organization. It does not return users that are added in the organization as guests. Official Miro endpoint: GET /Users/{id}.
miro.miro_replace_user Write write 0 Updates an existing user resource. This is the easiest way to replace user information. If the user is deactivated, userName, userType, and roles.value cannot be updated. emails.value, emails.display, emails.primary get ignored and do not return any error. Not
miro.miro_patch_user Write write 0 Updates an existing user resource, overwriting values for specified attributes. Attributes that are not provided will remain unchanged. PATCH operation only updates the fields provided. Note: If the user is not a member in the organization, they cannot be upda
miro.miro_delete_user Write write 0 Deletes a single user from the organization. Note: A user who is the last admin in the team or the last admin in the organization cannot be deleted. User must be a member in the organization to be deleted. Users that have guest role in the organization cannot
miro.miro_list_groups Read read 0 Retrieves the list of groups (teams) in the organization. Note: Along with groups (teams), the users that are part of those groups (teams) are also retrieved. Only users that have member role in the organization are fetched. Official Miro endpoint: GET /Group
miro.miro_get_group Read read 0 Retrieves a single Group resource. Note: Along with groups (teams), the users that are part of those groups (teams) are also retrieved. Only users that have member role in the organization are fetched. Official Miro endpoint: GET /Groups/{id}.
miro.miro_patch_group Write write 0 Updates 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 team members and to update the display name of the group (team). To add a user to the group (team), u
miro.miro_list_service_provider_configs Read read 0 Retrieve supported operations and SCIM API basic configuration. Official Miro endpoint: GET /ServiceProviderConfig.
miro.miro_list_resource_types Read read 0 Retrieve information about which SCIM resources are supported. Currently, Miro supports Users and Groups as Resource Types. Official Miro endpoint: GET /ResourceTypes.
miro.miro_get_resource_type Read read 0 Retrieve metadata for the available resource types (User and Group) that are supported. Official Miro endpoint: GET /ResourceTypes/{resource}.
miro.miro_list_schemas Read read 0 Retrieve metadata about Users, Groups, and extension attributes that are currently supported. Official Miro endpoint: GET /Schemas.
miro.miro_get_schema Read read 0 Retrieve information about how users, groups, and enterprise-user attributes URIs that are formatted. Official Miro endpoint: GET /Schemas/{uri}.
miro.miro_enterprise_get_organization Read read 0 Retrieves organization information. Required scope organizations:read Rate limiting Level 3 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary
miro.miro_enterprise_get_organization_members Read read 0 Retrieves organization members based on the organization ID and the cursor, or based on the user emails provided in the request. Required scope organizations:read Rate limiting Level 3 Enterprise only This API is available only for Enterprise plan users. You c
miro.miro_enterprise_get_organization_member Read read 0 Retrieves organization member information for an existing organization. Required scope organizations:read Rate limiting Level 3 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Compa
miro.miro_create_board Write write 0 Creates a board with the specified name and sharing policies. Note You can only create up to 3 team boards with the free plan. Required scope boards:write Rate limiting Level 3 Official Miro endpoint: POST /v2/boards.
miro.miro_get_boards Read read 0 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. Fil
miro.miro_copy_board Write write 0 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. Required scope boards:write Rate limiting Level 4 Official Miro endpoint: PUT /v2/boards.
miro.miro_get_specific_board Read read 0 Retrieves information about a board. Required scope boards:read Rate limiting Level 1 Official Miro endpoint: GET /v2/boards/{board_id}.
miro.miro_update_board Write write 0 Updates a specific board. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: PATCH /v2/boards/{board_id}.
miro.miro_delete_board Write write 0 Deletes a board. Deleted boards go to Trash (on paid plans) and can be restored via UI within 90 days after deletion. Required scope boards:write Rate limiting Level 3 Official Miro endpoint: DELETE /v2/boards/{board_id}.
miro.miro_create_app_card_item Write write 0 Adds an app card item to a board. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: POST /v2/boards/{board_id}/app_cards.
miro.miro_get_app_card_item Read read 0 Retrieves information for a specific app card item on a board. Required scope boards:read Rate limiting Level 1 Official Miro endpoint: GET /v2/boards/{board_id}/app_cards/{item_id}.
miro.miro_update_app_card_item Write write 0 Updates an app card item on a board based on the data and style properties provided in the request body. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: PATCH /v2/boards/{board_id}/app_cards/{item_id}.
miro.miro_delete_app_card_item Write write 0 Deletes an app card item from a board. Required scope boards:write Rate limiting Level 3 Official Miro endpoint: DELETE /v2/boards/{board_id}/app_cards/{item_id}.
miro.miro_create_card_item Write write 0 Adds a card item to a board Required scope boards:write Rate limiting Level 2 Official Miro endpoint: POST /v2/boards/{board_id}/cards.
miro.miro_get_card_item Read read 0 Retrieves information for a specific card item on a board Required scope boards:read Rate limiting Level 1 Official Miro endpoint: GET /v2/boards/{board_id}/cards/{item_id}.
miro.miro_update_card_item Write write 0 Updates a card item on a board based on the data and style properties provided in the request body. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: PATCH /v2/boards/{board_id}/cards/{item_id}.
miro.miro_delete_card_item Write write 0 Deletes a card item from the board. Required scope boards:write Rate limiting Level 3 Official Miro endpoint: DELETE /v2/boards/{board_id}/cards/{item_id}.
miro.miro_create_connector Write write 0 Adds a connector to a board. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: POST /v2/boards/{board_id}/connectors.
miro.miro_get_connectors Read read 0 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
miro.miro_get_connector Read read 0 Retrieves information for a specific connector on a board. Required scope boards:read Rate limiting Level 1 Official Miro endpoint: GET /v2/boards/{board_id}/connectors/{connector_id}.
miro.miro_update_connector Write write 0 Updates a connector on a board based on the data and style properties provided in the request body. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: PATCH /v2/boards/{board_id}/connectors/{connector_id}.
miro.miro_delete_connector Write write 0 Deletes the specified connector from the board. Required scope boards:write Rate limiting Level 3 Official Miro endpoint: DELETE /v2/boards/{board_id}/connectors/{connector_id}.
miro.miro_create_document_item_using_url Write write 0 Adds a document item to a board by specifying the URL where the document is hosted. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: POST /v2/boards/{board_id}/documents.
miro.miro_get_document_item Read read 0 Retrieves information for a specific document item on a board Required scope boards:read Rate limiting Level 1 Official Miro endpoint: GET /v2/boards/{board_id}/documents/{item_id}.
miro.miro_update_document_item_using_url Write write 0 Updates a document item on a board Required scope boards:write Rate limiting Level 2 Official Miro endpoint: PATCH /v2/boards/{board_id}/documents/{item_id}.
miro.miro_delete_document_item Write write 0 Deletes a document item from the board. Required scope boards:write Rate limiting Level 3 Official Miro endpoint: DELETE /v2/boards/{board_id}/documents/{item_id}.
miro.miro_create_embed_item Write write 0 Adds an embed item containing external content to a board. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: POST /v2/boards/{board_id}/embeds.
miro.miro_get_embed_item Read read 0 Retrieves information for a specific embed item on a board. Required scope boards:read Rate limiting Level 1 Official Miro endpoint: GET /v2/boards/{board_id}/embeds/{item_id}.
miro.miro_update_embed_item Write write 0 Updates an embed item on a board based on the data properties provided in the request body. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: PATCH /v2/boards/{board_id}/embeds/{item_id}.
miro.miro_delete_embed_item Write write 0 Deletes an embed item from the board. Required scope boards:write Rate limiting Level 3 Official Miro endpoint: DELETE /v2/boards/{board_id}/embeds/{item_id}.
miro.miro_create_image_item_using_url Write write 0 Adds an image item to a board by specifying an image URL. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: POST /v2/boards/{board_id}/images.
miro.miro_get_image_item Read read 0 Retrieves information for a specific image item on a board. Required scope boards:read Rate limiting Level 1 Official Miro endpoint: GET /v2/boards/{board_id}/images/{item_id}.
miro.miro_update_image_item_using_url Write write 0 Updates an image item on a board. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: PATCH /v2/boards/{board_id}/images/{item_id}.
miro.miro_delete_image_item Write write 0 Deletes an image item from the board. Required scope boards:write Rate limiting Level 3 Official Miro endpoint: DELETE /v2/boards/{board_id}/images/{item_id}.
miro.miro_get_items Read read 0 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
miro.miro_get_specific_item Read read 0 Retrieves information for a specific item on a board. Required scope boards:read Rate limiting Level 1 Official Miro endpoint: GET /v2/boards/{board_id}/items/{item_id}.
miro.miro_update_item_position_or_parent Write write 0 Updates the position or the parent of an item on a board. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: PATCH /v2/boards/{board_id}/items/{item_id}.
miro.miro_delete_item Write write 0 Deletes an item from a board. Required scope boards:write Rate limiting Level 3 Official Miro endpoint: DELETE /v2/boards/{board_id}/items/{item_id}.
miro.miro_share_board Write write 0 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. Requi
miro.miro_get_board_members Read read 0 Retrieves a pageable list of members for a board. Required scope boards:read Rate limiting Level 1 Official Miro endpoint: GET /v2/boards/{board_id}/members.
miro.miro_get_specific_board_member Read read 0 Retrieves information for a board member. Required scope boards:read Rate limiting Level 1 Official Miro endpoint: GET /v2/boards/{board_id}/members/{board_member_id}.
miro.miro_update_board_member Write write 0 Updates the role of a board member. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: PATCH /v2/boards/{board_id}/members/{board_member_id}.
miro.miro_remove_board_member Write write 0 Removes a board member from a board. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: DELETE /v2/boards/{board_id}/members/{board_member_id}.
miro.miro_create_shape_item Write write 0 Adds a shape item to a board. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: POST /v2/boards/{board_id}/shapes.
miro.miro_get_shape_item Read read 0 Retrieves information for a specific shape item on a board. Required scope boards:read Rate limiting Level 1 Official Miro endpoint: GET /v2/boards/{board_id}/shapes/{item_id}.
miro.miro_update_shape_item Write write 0 Updates a shape item on a board based on the data and style properties provided in the request body. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: PATCH /v2/boards/{board_id}/shapes/{item_id}.
miro.miro_delete_shape_item Write write 0 Deletes a shape item from the board. Required scope boards:write Rate limiting Level 3 Official Miro endpoint: DELETE /v2/boards/{board_id}/shapes/{item_id}.
miro.miro_create_sticky_note_item Write write 0 Adds a sticky note item to a board. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: POST /v2/boards/{board_id}/sticky_notes.
miro.miro_get_sticky_note_item Read read 0 Retrieves information for a specific sticky note item on a board. Required scope boards:read Rate limiting Level 1 Official Miro endpoint: GET /v2/boards/{board_id}/sticky_notes/{item_id}.
miro.miro_update_sticky_note_item Write write 0 Updates a sticky note item on a board based on the data and style properties provided in the request body. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: PATCH /v2/boards/{board_id}/sticky_notes/{item_id}.
miro.miro_delete_sticky_note_item Write write 0 Deletes a sticky note item from the board. Required scope boards:write Rate limiting Level 3 Official Miro endpoint: DELETE /v2/boards/{board_id}/sticky_notes/{item_id}.
miro.miro_create_text_item Write write 0 Adds a text item to a board. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: POST /v2/boards/{board_id}/texts.
miro.miro_get_text_item Read read 0 Retrieves information for a specific text item on a board. Required scope boards:read Rate limiting Level 1 Official Miro endpoint: GET /v2/boards/{board_id}/texts/{item_id}.
miro.miro_update_text_item Write write 0 Updates a text item on a board based on the data and style properties provided in the request body. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: PATCH /v2/boards/{board_id}/texts/{item_id}.
miro.miro_delete_text_item Write write 0 Deletes a text item from the board Required scope boards:write Rate limiting Level 3 Official Miro endpoint: DELETE /v2/boards/{board_id}/texts/{item_id}.
miro.miro_create_items Write write 0 Adds 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, 4 card items, and 5 sticky notes in one create call. The bulk create operation is transactional. If a
miro.miro_create_frame_item Write write 0 Adds a frame to a board. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: POST /v2/boards/{board_id}/frames.
miro.miro_get_frame_item Read read 0 Retrieves information for a specific frame on a board. Required scope boards:read Rate limiting Level 1 Official Miro endpoint: GET /v2/boards/{board_id}/frames/{item_id}.
miro.miro_update_frame_item Write write 0 Updates a frame on a board based on the data, style, or geometry properties provided in the request body. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: PATCH /v2/boards/{board_id}/frames/{item_id}.
miro.miro_delete_frame_item Write write 0 Deletes a frame from a board. Required scope boards:write Rate limiting Level 3 Official Miro endpoint: DELETE /v2/boards/{board_id}/frames/{item_id}.
miro.miro_get_items_within_frame Read read 0 Retrieves 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 cursor-based approach. A cursor-paginated method returns a portion of the total set of results based o
miro.miro_create_items_in_bulk_using_file_from_device Write write 0 Adds 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 can create 5 document items and 5 images in one create call. The bulk create operation is transaction
miro.miro_get_metrics Read read 0 Returns 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 token. It can be generated in the Your Apps section of Developer Hub. Required scope boards:read Rate limi
miro.miro_get_metrics_total Read read 0 Returns 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 your apps section of Developer Hub. Required scope boards:read Rate limiting Level 1 Official Miro endpoint: G
miro.miro_get_mindmap_node_experimental Read read 0 Retrieves information for a specific mind map node on a board. Required scope boards:read Rate limiting Level 1 Official Miro endpoint: GET /v2-experimental/boards/{board_id}/mindmap_nodes/{item_id}.
miro.miro_delete_mindmap_node_experimental Write write 0 Deletes a mind map node item and its child nodes from the board. Required scope boards:write Rate limiting Level 3 Official Miro endpoint: DELETE /v2-experimental/boards/{board_id}/mindmap_nodes/{item_id}.
miro.miro_get_mindmap_nodes_experimental Read read 0 Retrieves 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 portion of the total set of results based on the limit specified and a cursor that points to the next portio
miro.miro_create_mindmap_nodes_experimental Write write 0 Adds 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 mind maps, use cases, mind map structure, and more, see the Mind Map Overview page. Required scope bo
miro.miro_get_items_experimental Read read 0 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
miro.miro_get_specific_item_experimental Read read 0 Retrieves information for a specific item on a board. Required scope boards:read Rate limiting Level 1 Official Miro endpoint: GET /v2-experimental/boards/{board_id}/items/{item_id}.
miro.miro_delete_item_experimental Write write 0 Deletes an item from a board. Required scope boards:write Rate limiting Level 3 Official Miro endpoint: DELETE /v2-experimental/boards/{board_id}/items/{item_id}.
miro.miro_create_shape_item_flowchart Write write 0 Adds a flowchart shape item to a board. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: POST /v2-experimental/boards/{board_id}/shapes.
miro.miro_get_shape_item_flowchart Read read 0 Retrieves information for a specific shape item on a board. Required scope boards:read Rate limiting Level 1 Official Miro endpoint: GET /v2-experimental/boards/{board_id}/shapes/{item_id}.
miro.miro_update_shape_item_flowchart Write write 0 Updates a flowchart shape item on a board based on the data and style properties provided in the request body. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: PATCH /v2-experimental/boards/{board_id}/shapes/{item_id}.
miro.miro_delete_shape_item_flowchart Write write 0 Deletes a flowchart shape item from the board. Required scope boards:write Rate limiting Level 3 Official Miro endpoint: DELETE /v2-experimental/boards/{board_id}/shapes/{item_id}.
miro.miro_get_code_widget_items Read read 0 Retrieves 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 portion of the total set of results based on the limit specified and a cursor that points to the next por
miro.miro_create_code_widget_item Write write 0 Adds a code widget item to a board. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: POST /v2-experimental/boards/{board_id}/code_widgets.
miro.miro_get_code_widget_item Read read 0 Retrieves information for a specific code widget item on a board. Required scope boards:read Rate limiting Level 1 Official Miro endpoint: GET /v2-experimental/boards/{board_id}/code_widgets/{item_id}.
miro.miro_update_code_widget_item Write write 0 Updates a code widget item on a board based on the data properties provided in the request body. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: PATCH /v2-experimental/boards/{board_id}/code_widgets/{item_id}.
miro.miro_delete_code_widget_item Write write 0 Deletes a code widget item from the board. Required scope boards:write Rate limiting Level 3 Official Miro endpoint: DELETE /v2-experimental/boards/{board_id}/code_widgets/{item_id}.
miro.miro_move_code_widget_item Write write 0 Updates the position of a code widget item on a board. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: PATCH /v2-experimental/boards/{board_id}/code_widgets/{item_id}/position.
miro.miro_create_document_item_using_file_from_device Write write 0 Adds a document item to a board by selecting file from device. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: POST /v2/boards/{board_id_PlatformFileUpload}/documents.
miro.miro_update_document_item_using_file_from_device Write write 0 Updates a document item on a board by using file from a device. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: PATCH /v2/boards/{board_id_PlatformFileUpload}/documents/{item_id}.
miro.miro_create_image_item_using_local_file Write write 0 Adds an image item to a board by specifying a file from device. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: POST /v2/boards/{board_id_PlatformFileUpload}/images.
miro.miro_update_image_item_using_file_from_device Write write 0 Updates an image item on a board. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: PATCH /v2/boards/{board_id_PlatformFileUpload}/images/{item_id}.
miro.miro_create_group Write write 0 Creates a group of items on a board. The group is created with the items that are passed in the request body. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: POST /v2/boards/{board_id}/groups.
miro.miro_get_all_groups Read read 0 Returns all the groups and the items of the respective groups within 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
miro.miro_get_items_by_group_id Read read 0 Returns a list of items that are a part of any group, within 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 poi
miro.miro_get_group_by_id Read read 0 Returns a list of items in a specific group. Required scope boards:read Rate limiting Level 2 per item ID Official Miro endpoint: GET /v2/boards/{board_id}/groups/{group_id}.
miro.miro_un_group Write write 0 Ungroups items from a group. Required scope boards:write Rate limiting Level 3 Official Miro endpoint: DELETE /v2/boards/{board_id}/groups/{group_id}.
miro.miro_update_group Write write 0 This 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 new group ID is assigned. Required scope boards:write Rate limiting Level 2 Official Miro endpoint: PU
miro.miro_delete_group Write write 0 Deletes a group from a board. All the items in the group are deleted along with the group. Note - this endpoint will delete items which are locked as well. Required scope boards:write Rate limiting Level 3 Official Miro endpoint: DELETE /v2/boards/{board_id}/
miro.miro_revoke_token_v2 Write write 0 Revoke 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 is also revoked and no longer valid. This does not uninstall the application for the user. Official M
miro.miro_get_tags_from_item Read read 0 Retrieves all the tags from the specified item. Required scope boards:read Rate limiting Level 1 Official Miro endpoint: GET /v2/boards/{board_id}/items/{item_id}/tags.
miro.miro_create_tag Write write 0 Creates a tag on a board. Required scope boards:write Rate limiting Level 1 Official Miro endpoint: POST /v2/boards/{board_id}/tags.
miro.miro_get_tags_from_board Read read 0 Retrieves all the tags from the specified board. Required scope boards:read Rate limiting Level 1 Official Miro endpoint: GET /v2/boards/{board_id}/tags.
miro.miro_get_tag Read read 0 Retrieves information for a specific tag. Required scope boards:write Rate limiting Level 1 Official Miro endpoint: GET /v2/boards/{board_id}/tags/{tag_id}.
miro.miro_update_tag Write write 0 Updates a tag based on the data properties provided in the request body. Note: Updates to tags made via the REST API will not be reflected on the board in realtime. To see REST API updates to tags on a board, you need to refresh the board. This applies to the
miro.miro_delete_tag Write write 0 Deletes the specified tag from the board. The tag is also removed from all cards and sticky notes on the board. Note: Updates to tags made via the REST API will not be reflected on the board in realtime. To see REST API updates to tags on a board, you need to
miro.miro_get_items_by_tag Read read 0 Retrieves all the items that have the specified tag. Required scope boards:read Rate limiting Level 1 Official Miro endpoint: GET /v2/boards/{board_id_PlatformTags}/items.
miro.miro_attach_tag_to_item Write write 0 Attach an existing tag to the specified item. Card and sticky note items can have up to 8 tags. Note: Updates to tags made via the REST API will not be reflected on the board in realtime. To see REST API updates to tags on a board, you need to refresh the boar
miro.miro_remove_tag_from_item Write write 0 Removes the specified tag from the specified item. The tag still exists on the board. Note: Updates to tags made via the REST API will not be reflected on the board in realtime. To see REST API updates to tags on a board, you need to refresh the board. This ap
miro.miro_enterprise_create_project Write write 0 Projects 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 organize your boards and make them easier to find and share. In other words, a project is a group of boa
miro.miro_enterprise_get_projects Read read 0 Retrieves the list of projects in an existing team of an organization. You can retrieve all projects, including all private projects (projects that haven't been specifically shared with you) by enabling Content Admin permissions. To enable Content Admin permis
miro.miro_enterprise_get_project Read read 0 Retrieves project information, such as a name for an existing project.Note Projects have been renamed to Spaces, and the terms can be used interchangeably.Required scope projects:read Rate limiting Level 1 Enterprise only This API is available only for Enterpr
miro.miro_enterprise_update_project Write write 0 Update information about a project, such as the project name.Note Projects have been renamed to Spaces, and the terms can be used interchangeably.Required scope projects:write Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan
miro.miro_enterprise_delete_project Write write 0 Deletes a project. After a project is deleted, all boards and users that belong to the project remain in the team.Note Projects have been renamed to Spaces, and the terms can be used interchangeably.Required scope projects:write Rate limiting Level 4 Enterpris
miro.miro_enterprise_get_project_settings Read read 0 Retrieves the project settings.Note Projects have been renamed to Spaces, and the terms can be used interchangeably.Required scope projects:read Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this e
miro.miro_enterprise_update_project_settings Write write 0 Updates the settings of a project.Note Projects have been renamed to Spaces, and the terms can be used interchangeably.Required scope projects:write Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use th
miro.miro_enterprise_add_project_member Write write 0 Add a Miro user to a project.Note Projects have been renamed to Spaces, and the terms can be used interchangeably.Required scope projects:write Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this en
miro.miro_enterprise_get_project_members Read read 0 Retrieves the list of members for a specific project.Note Projects have been renamed to Spaces, and the terms can be used interchangeably.Required scope projects:read Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. Y
miro.miro_enterprise_get_project_member Read read 0 Retrieves information for a specific project member.Note Projects have been renamed to Spaces, and the terms can be used interchangeably.Required scope projects:read Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. Yo
miro.miro_enterprise_update_project_member Write write 0 Updates details of a project member, such as the member's role.Note Projects have been renamed to Spaces, and the terms can be used interchangeably.Required scope projects:write Rate limiting Level 1 Enterprise only This API is available only for Enterprise pl
miro.miro_enterprise_delete_project_member Write write 0 Remove a member from a project. The user remains in the team even after the member is removed from a project.Note Projects have been renamed to Spaces, and the terms can be used interchangeably.Required scope projects:write Rate limiting Level 4 Enterprise onl
miro.miro_enterprise_create_team Write write 0 Creates a new team in an existing organization. Required scope organizations:teams:write Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can
miro.miro_enterprise_get_teams Read read 0 Retrieves list of teams in an existing organization. Required scope organizations:teams:read Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You
miro.miro_enterprise_get_team Read read 0 Retrieves team information for an existing team. Required scope organizations:teams:read Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can
miro.miro_enterprise_update_team Write write 0 Updates an existing team. Required scope organizations:teams:write Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary acc
miro.miro_enterprise_delete_team Write write 0 Deletes an existing team. Required scope organizations:teams:write Rate limiting Level 4 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary acc
miro.miro_enterprise_invite_team_member Write write 0 Invites 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 the team via [SCIM](https://developers.miro.com/docs/scim) and an external identity provider, such as
miro.miro_enterprise_get_team_members Read read 0 Retrieves team members by cursor. Required scope organizations:teams:read Rate limiting Level 2 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request tempor
miro.miro_enterprise_get_team_member Read read 0 Retrieves team member by id. Required scope organizations:teams:read Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary a
miro.miro_enterprise_update_team_member Write write 0 Updates team member role in team by id. Required scope organizations:teams:write Rate limiting Level 2 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request
miro.miro_enterprise_delete_team_member Write write 0 Deletes team member from team by id. Required scope organizations:teams:write Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request te
miro.miro_enterprise_get_default_team_settings Read read 0 Retrieves default team settings of an existing organization. Required scope organizations:teams:read Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Ad
miro.miro_enterprise_get_team_settings Read read 0 Retrieves team settings of an existing team. Required scope organizations:teams:read Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can req
miro.miro_enterprise_update_team_settings Write write 0 Updates team settings of an existing team. Required scope organizations:teams:write Rate limiting Level 2 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can requ
miro.miro_enterprise_get_groups Read read 0 Retrieves the list of user groups in an organization. Required scope organizations:groups:read Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. Y
miro.miro_enterprise_create_group Write write 0 Creates a new user group in an organization. Required scope organizations:groups:write Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can r
miro.miro_enterprise_get_group Read read 0 Retrieves a user group in an organization. Required scope organizations:groups:read Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can requ
miro.miro_enterprise_update_group Write write 0 Updates a user group in an organization. Required scope organizations:groups:write Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can reque
miro.miro_enterprise_delete_group Write write 0 Deletes a user group from an organization. Required scope organizations:groups:write Rate limiting Level 4 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can req
miro.miro_enterprise_get_group_members Read read 0 Retrieves the list of members who are part of a team in an existing organization. Required scope organizations:groups:read Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have th
miro.miro_enterprise_create_group_member Write write 0 Adds a member to a user group in an organization. Required scope organizations:groups:write Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You
miro.miro_enterprise_update_group_members Write write 0 Add 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. Required scope organizations:groups:write Rate limiting Level 1 per item. For example, if you want to add 10 users and remove 5,
miro.miro_enterprise_get_group_member Read read 0 Retrieves information about a user group member in an organization. Required scope organizations:groups:read Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Co
miro.miro_enterprise_delete_group_member Write write 0 Removes a member from a user group in an organization. Required scope organizations:groups:write Rate limiting Level 4 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin.
miro.miro_enterprise_groups_get_teams Read read 0 Retrieves the list of teams that the user group is a part of. Required scope organizations:groups:read organizations:teams:readRate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you hav
miro.miro_enterprise_groups_get_team Read read 0 Retrieves information of a team that the user group is a part of in an organization. Required scope organizations:groups:read organizations:teams:readRate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use t
miro.miro_enterprise_teams_get_groups Read read 0 Retrieves the list of user groups that are part of a team in an organization. Required scope organizations:groups:read organizations:teams:read Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this en
miro.miro_enterprise_teams_create_group Write write 0 Adds a user group to a team in an organization. Required scope organizations:groups:read organizations:teams:write Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role o
miro.miro_enterprise_teams_get_group Read read 0 Retrieves information about a specific user group of a team. Required scope organizations:groups:read organizations:teams:read Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you hav
miro.miro_enterprise_teams_delete_group Write write 0 Removes a user group from a team in an existing organization. Required scope organizations:groups:read organizations:teams:write Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you h
miro.miro_enterprise_boards_get_groups Read read 0 Retrieves information about user groups invited to the specified board. Required scope organizations:groups:read boards:read Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have
miro.miro_enterprise_boards_create_group Write write 0 Shares a board with user groups with a specified role. Updates the role if already shared. Required scope organizations:groups:read boards:write Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this e
miro.miro_enterprise_boards_delete_groups Write write 0 Removes a user group from the specified board. Required scope organizations:groups:read boards:write Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Ad
miro.miro_enterprise_projects_get_groups Read read 0 Retrieves information about user groups invited to the specified project. Required scope organizations:groups:read projects:read Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you h
miro.miro_enterprise_project_create_group Write write 0 Shares a project with user groups with a specified role. Updates the role if already shared. Required scope organizations:groups:read projects:write Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use th
miro.miro_enterprise_project_delete_groups Write write 0 Removes a user group from the specified project. Required scope organizations:groups:read projects:write Rate limiting Level 1 Enterprise only This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Compan