Articles in this section

Available Miro APIs

When you configure an export, import, or other type of flow step using the prebuilt Miro connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Miro API documentation. You can also create a composite endpoint for this application in HTTP mode.

API type: REST

Resource

API endpoint

Export

Import

App card items

Get app card item

X

Create app card item

X

Update app card item

X

Delete app card item

X

Audit logs (Enterprise plan)

Get audit logs

X

Board classification (Enterprise plan): Board level

Get board classification

X

Update board classification

X

Board classification (Enterprise plan): Organization level

Get organization settings

X

Board classification (Enterprise plan): Team level

Get team settings

X

Bulk update boards classification

X

Update team settings

X

Board members

Get all board members

X

Get specific board member

X

Share board

X

Update board member

X

Remove board member

X

Boards

Get boards

X

Get specific board

X

Create board

X

Copy board

X

Update board

X

Delete board

X

Card items

Get card item

X

Create card item

X

Update card item

X

Delete card item

X

Connectors

Get connectors

X

Get specific connector

X

Create connector

X

Update connector

X

Delete connector

X

Document items

Get document item

X

Create document item using URL

X

Create document item using file from device

X

Update document item using file from device

X

Update document item using URL

X

Delete document item

X

E-discovery (Enterprise guard): Board content logs

Retrieve content change logs of board items

X

E-discovery (Enterprise guard): Board export

Get board export job status

X

Get results for board export job

X

Create board export job

X

E-discovery (Enterprise guard): Legal holds

Get all cases

X

Get case

X

Get all legal holds within a case

X

Get legal hold information

X

Get content items under legal hold

X

Embed items

Get embed item

X

Create embed item

X

Update embed item

X

Delete embed item

X

Frame items

Get items within frame

X

Get frame

X

Create frame

X

Update frame

X

Delete frame

X

Groups

Get all groups on a board

X

Get items of a group by ID

X

Get a group by its ID

X

Create group

X

Ungroup items

X

Update group

X

Deletes the group

X

Image items

Get image item

X

Create image items using file from device

X

Update image items using file from device

X

Create image item using URL

X

Update image item using URL

X

Delete image item

X

Items

Get items on board

X

Get specific item on board

X

Update item position or parent

X

Delete item

X

Organization (Enterprise plan)

Get organization info

X

Organization (Enterprise plan): Organization members

Get organization members

X

Get organization member

X

Platform experimental features: App metrics (Experimental)

Get app metrics

X

Get total app metrics

X

Platform experimental features: Flowchart shapes (Experimental)

Get items on board

X

Get specific item on board

X

Get shape item

X

Create shape item

X

Update shape item

X

Delete shape item

X

Platform experimental features: Mind map nodes (Experimental)

Get specific mind map node

X

Get mind map nodes

X

Delete mind map node

X

Create mind map node

X

Platform experimental features: Webhooks (Experimental)

Get webhook subscriptions

X

Create webhook subscription

X

Update webhook subscription

X

Get specific webhook subscription

X

Delete webhook subscription

X

Project (Enterprise plan): Project members

List of project members

X

Get project member

X

Add member in a project

X

Update project member

X

Remove project member

X

Project (Enterprise plan): Project settings

Get project settings

X

Update project settings

X

Project (Enterprise plan): Projects

List of projects

X

Get project

X

Create project

X

Update project

X

Delete project

X

Shape items

Get shape item

X

Create shape item

X

Update shape item

X

Delete shape item

X

Sticky note items

Get sticky note item

X

Create sticky note item

X

Update sticky note item

X

Delete sticky note item

X

Tags

Get items by tag

X

Get tags from item

X

Get tags from board

X

Get tag

X

Attach tag to item

X

Remove tag from item

X

Create tag

X

Update tag

X

Delete tag

X

Teams (Enterprise plan): Team members

List team members

X

Get team member

X

Invite team members

X

Update team member

X

Delete team member from team

X

Teams (Enterprise plan): Team settings

Get default team settings

X

Get team settings

X

Update team settings

X

Teams (Enterprise plan): Teams

List teams

X

Get team

X

Create team

X

Update team

X

Delete team

X

Text items

Get text item

X

Create text item

X

Update text item

X

Delete text item

X

API type: SCIM

Resource

API endpoint

Export

Import

Groups

Retrieve list of groups

X

Retrieve a single group

X

Update an existing group

X

Resource types

List of resource types

X

Return metadata for user resource type

X

Return metadata for group resource type

X

Schemas

List schemas

X

Service provider config

Returns supported operations

X

Users

Get users

X

Get user by ID

X

Create a new user

X

Replace user by ID

X

Update user attribute by ID

X

Delete user by ID

X