Class MiroApi

Hierarchy

  • MiroApi

Constructors

constructor

Properties

accessToken basePath httpTimeout? logger?

Methods

attachTagToItem call copyBoard createAppCardItem createBoard createBoardSubscription createCardItem createConnector createDocumentItemUsingFileFromDevice createDocumentItemUsingUrl createEmbedItem createFrameItem createGroup createImageItemUsingLocalFile createImageItemUsingUrl createItems createItemsInBulkUsingFileFromDevice createMindmapNodesExperimental createShapeItem createShapeItemFlowchart createStickyNoteItem createTag createTextItem deleteAppCardItem deleteBoard deleteCardItem deleteConnector deleteDocumentItem deleteEmbedItem deleteFrameItem deleteGroup deleteImageItem deleteItem deleteItemExperimental deleteMindmapNodeExperimental deleteShapeItem deleteShapeItemFlowchart deleteStickyNoteItem deleteSubscriptionById deleteTag deleteTextItem enterpriseAddProjectMember enterpriseBoardContentItemLogsFetch enterpriseBoardExportJobResults enterpriseBoardExportJobStatus enterpriseCreateBoardExport enterpriseCreateProject enterpriseCreateTeam enterpriseDataclassificationBoardGet enterpriseDataclassificationBoardSet enterpriseDataclassificationOrganizationSettingsGet enterpriseDataclassificationTeamBoardsBulk enterpriseDataclassificationTeamSettingsGet enterpriseDataclassificationTeamSettingsSet enterpriseDeleteProject enterpriseDeleteProjectMember enterpriseDeleteTeam enterpriseDeleteTeamMember enterpriseGetAuditLogs enterpriseGetDefaultTeamSettings enterpriseGetOrganization enterpriseGetOrganizationMember enterpriseGetOrganizationMembers enterpriseGetProject enterpriseGetProjectMember enterpriseGetProjectMembers enterpriseGetProjectSettings enterpriseGetProjects enterpriseGetTeam enterpriseGetTeamMember enterpriseGetTeamMembers enterpriseGetTeamSettings enterpriseGetTeams enterpriseInviteTeamMember enterprisePostUserSessionsReset enterpriseUpdateProject enterpriseUpdateProjectMember enterpriseUpdateProjectSettings enterpriseUpdateTeam enterpriseUpdateTeamMember enterpriseUpdateTeamSettings getAllGroups getAppCardItem getBoardMembers getBoards getCardItem getConnector getConnectors getDocumentItem getEmbedItem getFrameItem getGroupById getImageItem getItems getItemsByGroupId getItemsByTag getItemsExperimental getItemsWithinFrame getMetrics getMetricsTotal getMindmapNodeExperimental getMindmapNodesExperimental getShapeItem getShapeItemFlowchart getSpecificBoard getSpecificBoardMember getSpecificItem getSpecificItemExperimental getStickyNoteItem getSubscriptionById getTag getTagsFromBoard getTagsFromItem getTextItem getUserSubscriptions removeBoardMember removeTagFromItem revokeToken shareBoard tokenInfo unGroup updateAppCardItem updateBoard updateBoardMember updateBoardSubscription updateCardItem updateConnector updateDocumentItemUsingFileFromDevice updateDocumentItemUsingUrl updateEmbedItem updateFrameItem updateGroup updateImageItemUsingFileFromDevice updateImageItemUsingUrl updateItemPositionOrParent updateShapeItem updateShapeItemFlowchart updateStickyNoteItem updateTag updateTextItem

Constructors

constructor

  • Parameters

    • accessToken: string | (() => Promise<string>)
    • basePath: string = defaultBasePath
    • Optional logger: Logger
    • Optional httpTimeout: number

    Returns MiroApi

Properties

accessToken

accessToken: string | (() => Promise<string>)

basePath

basePath: string

Optional httpTimeout

httpTimeout?: number

Optional logger

logger?: Logger

Methods

attachTagToItem

  • 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 board. This applies to the following endpoints: Remove tag from item, Update tag, Delete tag.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Attach tag to item

    Parameters

    • boardIdPlatformTags: string

      Unique identifier (ID) of the board with the item that you want to add a tag to.

    • itemId: string

      Unique identifier (ID) of the item to which you want to add a tag.

    • tagId: string

      Unique identifier (ID) of the tag you want to add to the item.

    Returns Promise<{
        body: object;
        response: Response;
    }>

call

  • Parameters

    • method: string
    • url: string
    • Optional body: string | FormData

    Returns Promise<{
        body: unknown;
        response: Response;
    }>

copyBoard

  • 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

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 4

    Summary

    Copy board

    Parameters

    • copyFrom: string

      Unique identifier (ID) of the board that you want to copy.

    • Optional copyBoardChanges: CopyBoardChanges

    Returns Promise<{
        body: BoardWithLinksAndWithoutProject;
        response: Response;
    }>

createAppCardItem

  • Adds an app card item to a board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Create app card item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to create the item.

    • appCardCreateRequest: AppCardCreateRequest

    Returns Promise<{
        body: AppCardItem;
        response: Response;
    }>

createBoard

  • 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

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Summary

    Create board

    Parameters

    Returns Promise<{
        body: BoardWithLinks;
        response: Response;
    }>

createBoardSubscription

  • Creates a webhook subscription to receive notifications when an item on a board is updated. Subscriptions are created per user, per board. You can create multiple subscriptions. We currently support all board items except tags, connectors, and comments.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Create webhook subscription

    Parameters

    Returns Promise<{
        body: BoardSubscription;
        response: Response;
    }>

createCardItem

  • Adds a card item to a board

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Create card item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to create the item.

    • cardCreateRequest: CardCreateRequest

    Returns Promise<{
        body: CardItem;
        response: Response;
    }>

createConnector

  • Adds a connector to a board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Create connector

    Parameters

    • boardId: string

      Unique identifier (ID) of the board for which you want to create the connector.

    • connectorCreationData: ConnectorCreationData

    Returns Promise<{
        body: ConnectorWithLinks;
        response: Response;
    }>

createDocumentItemUsingFileFromDevice

createDocumentItemUsingUrl

  • Adds a document item to a board by specifying the URL where the document is hosted.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Create document item using URL

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to create the item.

    • documentCreateRequest: DocumentCreateRequest

    Returns Promise<{
        body: DocumentItem;
        response: Response;
    }>

createEmbedItem

  • Adds an embed item containing external content to a board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Create embed item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to create the item.

    • embedCreateRequest: EmbedCreateRequest

    Returns Promise<{
        body: EmbedItem;
        response: Response;
    }>

createFrameItem

  • Adds a frame to a board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Create frame

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to create a frame.

    • frameCreateRequest: FrameCreateRequest

    Returns Promise<{
        body: FrameItem;
        response: Response;
    }>

createGroup

  • 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

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Create group

    Parameters

    • boardId: string
    • group: Group

    Returns Promise<{
        body: GroupResponseShort;
        response: Response;
    }>

createImageItemUsingLocalFile

  • Adds an image item to a board by specifying a file from device.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Create image item using file from device

    Parameters

    • boardIdPlatformFileUpload: string

      Unique identifier (ID) of the board where you want to create the item.

    • resource: RequestFile

      Select a file to upload. Maximum file size is 6 MB.

    • Optional data: UploadFileFromDeviceData

    Returns Promise<{
        body: ImageItem;
        response: Response;
    }>

createImageItemUsingUrl

  • Adds an image item to a board by specifying an image URL.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Create image item using URL

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to create the item.

    • imageCreateRequest: ImageCreateRequest

    Returns Promise<{
        body: ImageItem;
        response: Response;
    }>

createItems

  • 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 any item's create operation fails, the create operation for all the remaining items also fails, and none of the items will be created.

    To try out this API in our documentation:

    1. In the BODY PARAMS section, scroll down until you see ADD OBJECT (Figure 1).

    <img alt=“add src="https://files.readme.io/570dac1-small-add_object.png\">
    Figure 1. Add object user interface in readme

    2. Click ADD OBJECT, and then select or enter the appropriate values for parameters of the item that you want to add.

    3. Repeat steps 1 and 2 for each item that you want to add.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2 per item. For example, if you want to create one sticky note, one card, and one shape item in one call, the rate limiting applicable will be 300 credits. This is because create item calls take Level 2 rate limiting of 100 credits each, 100 for sticky note, 100 for card, and 100 for shape item.

    Summary

    Create items in bulk

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to create the item.

    • itemCreate: ItemCreate[]

    Returns Promise<{
        body: Items;
        response: Response;
    }>

createItemsInBulkUsingFileFromDevice

  • 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 transactional. If any item's create operation fails, the create operation for all the remaining items also fails, and none of the items will be created. To try out this API in our documentation: 1. In the BODY PARAMS section, select ADD FILE, and then upload a local file. Repeat for each item that you want to add. 2. Upload a JSON file that contains the bulk data for the items you want to create.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2 per item

    Summary

    Create items in bulk using file from device

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to create the item.

    • data: RequestFile

      JSON file containing bulk data, where each object represents an item to be created. For details, see JSON file example.

    • resources: RequestFile[]

      Array of items to create (PDFs, images, etc.). Maximum of 20 items.

    Returns Promise<{
        body: Items;
        response: Response;
    }>

createMindmapNodesExperimental

  • 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 <a href="https://developers.miro.com/docs/mind-maps\" target=_blank>Mind Map Overview page.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Known limitations on node placement: Currently, the create API supports explicit positions for nodes. This means that users can only place nodes based on the x, y coordinates provided in the position parameters. If the position is not provided in the request, nodes default to coordinates x=0, y=0, effectively placing them at the center of the board.

    Upcoming changes: We understand the importance of flexibility in node placement. We are actively working on implementing changes to support positioning nodes relative to their parent node as well. This enhancement offers a more dynamic and intuitive mind mapping experience.

    Additionally, we are actively working on providing the update API, further enhancing the functionality of mind map APIs.

    Summary

    Create mind map node

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to create the item.

    • mindmapCreateRequest: MindmapCreateRequest

    Returns Promise<{
        body: MindmapItem;
        response: Response;
    }>

createShapeItem

  • Adds a shape item to a board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Create shape item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to create the item.

    • shapeCreateRequest: ShapeCreateRequest

    Returns Promise<{
        body: ShapeItem;
        response: Response;
    }>

createShapeItemFlowchart

  • Adds a flowchart shape item to a board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Create shape item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to create the item.

    • shapeCreateRequest: ShapeCreateRequest

    Returns Promise<{
        body: ShapeItem;
        response: Response;
    }>

createStickyNoteItem

  • Adds a sticky note item to a board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Create sticky note item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to create the item.

    • stickyNoteCreateRequest: StickyNoteCreateRequest

    Returns Promise<{
        body: StickyNoteItem;
        response: Response;
    }>

createTag

  • Creates a tag on a board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Create tag

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to create the tag.

    • tagCreateRequest: TagCreateRequest

    Returns Promise<{
        body: TagWithLinks;
        response: Response;
    }>

createTextItem

  • Adds a text item to a board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Create text item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to create the item.

    • textCreateRequest: TextCreateRequest

    Returns Promise<{
        body: TextItem;
        response: Response;
    }>

deleteAppCardItem

  • Deletes an app card item from a board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Summary

    Delete app card item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to delete an item.

    • itemId: string

      Unique identifier (ID) of the item that you want to delete.

    Returns Promise<{
        body: object;
        response: Response;
    }>

deleteBoard

  • 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

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Summary

    Delete board

    Parameters

    • boardId: string

      Unique identifier (ID) of the board that you want to delete.

    Returns Promise<{
        body: object;
        response: Response;
    }>

deleteCardItem

  • Deletes a card item from the board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Summary

    Delete card item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to delete the item.

    • itemId: string

      Unique identifier (ID) of the item that you want to delete.

    Returns Promise<{
        body: object;
        response: Response;
    }>

deleteConnector

  • Deletes the specified connector from the board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Summary

    Delete connector

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to delete the connector.

    • connectorId: string

      Unique identifier (ID) of the connector that you want to delete.

    Returns Promise<{
        body: object;
        response: Response;
    }>

deleteDocumentItem

  • Deletes a document item from the board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Summary

    Delete document item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to delete the item.

    • itemId: string

      Unique identifier (ID) of the item that you want to delete.

    Returns Promise<{
        body: object;
        response: Response;
    }>

deleteEmbedItem

  • Deletes an embed item from the board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Summary

    Delete embed item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to delete the item.

    • itemId: string

      Unique identifier (ID) of the item that you want to delete.

    Returns Promise<{
        body: object;
        response: Response;
    }>

deleteFrameItem

  • Deletes a frame from a board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Summary

    Delete frame

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to delete the frame.

    • itemId: string

      Unique identifier (ID) of the frame that you want to delete.

    Returns Promise<{
        body: object;
        response: Response;
    }>

deleteGroup

  • Deletes a group from a board. All the items in the groups are deleted along with the group.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Summary

    Deletes the group

    Parameters

    • boardId: string

      Unique identifier (ID) of the board.

    • groupId: string

      Unique identifier (ID) of the group.

    • deleteItems: boolean

      Indicates whether the items should be removed. Set to `true` to delete items in the group.

    Returns Promise<{
        body: object;
        response: Response;
    }>

deleteImageItem

  • Deletes an image item from the board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Summary

    Delete image item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to delete the item.

    • itemId: string

      Unique identifier (ID) of the item that you want to delete.

    Returns Promise<{
        body: object;
        response: Response;
    }>

deleteItem

  • Deletes an item from a board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Summary

    Delete item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to delete the item.

    • itemId: string

      Unique identifier (ID) of the item that you want to delete.

    Returns Promise<{
        body: object;
        response: Response;
    }>

deleteItemExperimental

  • Deletes an item from a board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Summary

    Delete item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to delete the item.

    • itemId: string

      Unique identifier (ID) of the item that you want to delete.

    Returns Promise<{
        body: object;
        response: Response;
    }>

deleteMindmapNodeExperimental

  • Deletes a mind map node item and its child nodes from the board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Summary

    Delete mind map node

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to delete the mind map node.

    • itemId: string

      Unique identifier (ID) of the mind map node that you want to delete.

    Returns Promise<{
        body: object;
        response: Response;
    }>

deleteShapeItem

  • Deletes a shape item from the board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Summary

    Delete shape item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to delete the item.

    • itemId: string

      Unique identifier (ID) of the item that you want to delete.

    Returns Promise<{
        body: object;
        response: Response;
    }>

deleteShapeItemFlowchart

  • Deletes a flowchart shape item from the board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Summary

    Delete shape item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to delete the item.

    • itemId: string

      Unique identifier (ID) of the item that you want to delete.

    Returns Promise<{
        body: object;
        response: Response;
    }>

deleteStickyNoteItem

  • Deletes a sticky note item from the board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Summary

    Delete sticky note item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to delete the item.

    • itemId: string

      Unique identifier (ID) of the item that you want to delete.

    Returns Promise<{
        body: object;
        response: Response;
    }>

deleteSubscriptionById

  • Deletes the specified webhook subscription.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Delete webhook subscription

    Parameters

    • subscriptionId: string

      Unique identifier (ID) of the subscription that you want to delete

    Returns Promise<{
        body: object;
        response: Response;
    }>

deleteTag

  • 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 refresh the board. This applies to the following endpoints: Attach tag to item, Remove tag from item, Update tag.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Delete tag

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to delete a specific tag.

    • tagId: string

      Unique identifier (ID) of the tag that you want to delete.

    Returns Promise<{
        body: object;
        response: Response;
    }>

deleteTextItem

  • Deletes a text item from the board

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Summary

    Delete text item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to delete the item.

    • itemId: string

      Unique identifier (ID) of the item that you want to delete.

    Returns Promise<{
        body: object;
        response: Response;
    }>

enterpriseAddProjectMember

  • Add a Miro user to a project.

    Required scope

    projects:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Add member in a project

    Parameters

    • orgId: string

      The ID of the organization to which the project belongs.

    • teamId: string

      The ID of the team to which the project belongs.

    • projectId: string

      The ID of the project to which you want to add a user.

    • addProjectMemberRequest: AddProjectMemberRequest

    Returns Promise<{
        body: ProjectMember;
        response: Response;
    }>

enterpriseBoardContentItemLogsFetch

  • 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 on the board IDs and the emails of users who created, modified, or deleted a board item. Additionally, results can be paginated for easier viewing and processing.

    Required scope

    contentlogs:export

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 4

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin.

    Summary

    Retrieve content change logs of board items

    Parameters

    • orgId: string

      Unique identifier of the organization.

    • from: Date

      Filter content logs based on the date and time when the board item was last modified. This is the start date and time for the modified date duration. Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

    • to: Date

      Filter content logs based on the date and time when the board item was last modified. This is the end date and time for the modified date duration. Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

    • Optional query: {
          boardIds?: string[];
          cursor?: string;
          emails?: string[];
          limit?: number;
          sorting?: "desc" | "asc";
      }
      • Optional boardIds?: string[]
      • Optional cursor?: string
      • Optional emails?: string[]
      • Optional limit?: number
      • Optional sorting?: "desc" | "asc"

    Returns Promise<{
        body: GetBoardItemContentLogsResponse;
        response: Response;
    }>

enterpriseBoardExportJobResults

  • 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

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 4

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin and eDiscovery is enabled in the Settings. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Get results for board export job

    Parameters

    • orgId: string

      Unique identifier of the organization.

    • jobId: string

      Unique identifier of the job.

    Returns Promise<{
        body: BoardExportResult;
        response: Response;
    }>

enterpriseBoardExportJobStatus

  • Retrieves the status of the board export job.

    Required scope

    boards:export

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 4

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin and eDiscovery is enabled in the Settings. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Get board export job status

    Parameters

    • orgId: string

      Unique identifier of the organization.

    • jobId: string

      Unique identifier of the board export job.

    Returns Promise<{
        body: BoardExportJobStatus;
        response: Response;
    }>

enterpriseCreateBoardExport

  • Creates an export job for one or more boards.

    Required scope

    boards:export

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 4

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin and eDiscovery is enabled in the Settings. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Create board export job

    Parameters

    • orgId: string

      Unique identifier of the organization.

    • requestId: string

      Unique identifier of the board export job.

    • createBoardExportRequest: CreateBoardExportRequest

    Returns Promise<{
        body: BoardExportJobId;
        response: Response;
    }>

enterpriseCreateProject

  • 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 boards that you can share with your teammates all at once. For more information, see our <a href="https://help.miro.com/hc/en-us/articles/360018262033-Projects\" target=_blank>Help Center page on Projects.

    This API creates a new project in an existing team of an organization.

    Required scope

    projects:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Create project

    Parameters

    • orgId: string

      The ID of the organization within which you you want to create a project.

    • teamId: string

      The ID of the team within which you you want to create a project.

    • createProjectRequest: CreateProjectRequest

    Returns Promise<{
        body: Project;
        response: Response;
    }>

enterpriseCreateTeam

  • Creates a new team in an existing organization.

    Required scope

    organizations:teams:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Create team

    Parameters

    Returns Promise<{
        body: Team;
        response: Response;
    }>

enterpriseDataclassificationBoardGet

  • Retrieves board classification for a board.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Get board classification

    Parameters

    • orgId: string

      id of the organization

    • teamId: string

      id of the team

    • boardId: string

      Unique identifier of the board that you want to retrieve.

    Returns Promise<{
        body: BoardDataClassificationLabel;
        response: Response;
    }>

enterpriseDataclassificationBoardSet

  • Updates board classification for an existing board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Update board classification

    Parameters

    • orgId: string

      id of the organization

    • teamId: string

      id of the team

    • boardId: string

      Unique identifier of the board that you want to update.

    • dataClassificationLabelId: DataClassificationLabelId

    Returns Promise<{
        body: BoardDataClassificationLabel;
        response: Response;
    }>

enterpriseDataclassificationOrganizationSettingsGet

  • Retrieves board classification settings for an existing organization.

    Required scope

    organizations:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Get organization settings

    Parameters

    • orgId: string

      id of the organization

    Returns Promise<{
        body: DataClassificationOrganizationSettings;
        response: Response;
    }>

enterpriseDataclassificationTeamBoardsBulk

enterpriseDataclassificationTeamSettingsGet

  • Retrieves board classification settings for an existing team.

    Required scope

    organizations:teams:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Get team settings

    Parameters

    • orgId: string

      id of the organization

    • teamId: string

      id of the team

    Returns Promise<{
        body: DataClassificationTeamSettings;
        response: Response;
    }>

enterpriseDataclassificationTeamSettingsSet

  • Updates board classification settings for an existing team.

    Required scope

    organizations:teams:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Update team settings

    Parameters

    Returns Promise<{
        body: DataClassificationTeamSettings;
        response: Response;
    }>

enterpriseDeleteProject

  • Deletes a project. After a project is deleted, all boards and users that belong to the project remain in the team.

    Required scope

    projects:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 4

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Delete project

    Parameters

    • orgId: string

      The ID of the organization from which you want to delete a project.

    • teamId: string

      The ID of the team from which you want to delete a project.

    • projectId: string

      The ID of the project that you want to delete.

    Returns Promise<{
        body?: any;
        response: Response;
    }>

enterpriseDeleteProjectMember

  • Remove a member from a project. The user remains in the team even after the member is removed from a project.

    Required scope

    projects:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 4

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Remove project member

    Parameters

    • orgId: string

      The ID of the organization to which the project belongs.

    • teamId: string

      The ID of the team to which the project belongs.

    • projectId: string

      The ID of the project from which you want to remove a member.

    • memberId: string

      The ID of the member that you want to remove from a project.

    Returns Promise<{
        body?: any;
        response: Response;
    }>

enterpriseDeleteTeam

  • Deletes an existing team.

    Required scope

    organizations:teams:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 4

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Delete team

    Parameters

    • orgId: string

      The id of the Organization.

    • teamId: string

      The id of the Team.

    Returns Promise<{
        body?: any;
        response: Response;
    }>

enterpriseDeleteTeamMember

  • Deletes team member from team by id.

    Required scope

    organizations:teams:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Delete team member from team

    Parameters

    • orgId: string

      The id of the Organization.

    • teamId: string

      The id of the Team.

    • memberId: string

      The id of the Team Member

    Returns Promise<{
        body?: any;
        response: Response;
    }>

enterpriseGetAuditLogs

  • Retrieves a page of audit events.

    Required scope

    auditlogs:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Get audit logs

    Parameters

    • createdAfter: string

      Retrieve audit logs created after the date and time provided. This is the start date of the duration for which you want to retrieve audit logs. For example, if you want to retrieve audit logs between `2023-03-30T17:26:50.000Z` and `2023-04-30T17:26:50.000Z`, provide `2023-03-30T17:26:50.000Z` as the value for the `createdAfter` parameter.<br>Format: UTC, adheres to ISO 8601, including milliseconds and a trailing Z offset.&quot;

    • createdBefore: string

      Retrieve audit logs created before the date and time provided. This is the end date of the duration for which you want to retrieve audit logs. For example, if you want to retrieve audit logs between `2023-03-30T17:26:50.000Z` and `2023-04-30T17:26:50.000Z`, provide `2023-04-30T17:26:50.000Z` as the value for the `createdBefore` parameter.<br>Format: UTC, adheres to ISO 8601, including milliseconds and a trailing Z offset.

    • Optional query: {
          cursor?: string;
          limit?: number;
          sorting?: "ASC" | "DESC";
      }
      • Optional cursor?: string
      • Optional limit?: number
      • Optional sorting?: "ASC" | "DESC"

    Returns Promise<{
        body: AuditPage;
        response: Response;
    }>

enterpriseGetDefaultTeamSettings

  • Retrieves default team settings of an existing organization.

    Required scope

    organizations:teams:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Get default team settings

    Parameters

    • orgId: string

      The id of an Organization.

    Returns Promise<{
        body: TeamSettings;
        response: Response;
    }>

enterpriseGetOrganization

  • Retrieves organization information.

    Required scope

    organizations:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Get organization info

    Parameters

    • orgId: string

      id of the organization

    Returns Promise<{
        body: Organization;
        response: Response;
    }>

enterpriseGetOrganizationMember

  • Retrieves organization member information for an existing organization.

    Required scope

    organizations:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Get organization member

    Parameters

    • orgId: string

      id of the organization

    • memberId: string

      id of the organization member

    Returns Promise<{
        body: OrganizationMember;
        response: Response;
    }>

enterpriseGetOrganizationMembers

  • 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

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Get organization members

    Parameters

    • orgId: string

      id of the organization

    • Optional query: {
          active?: boolean;
          cursor?: string;
          emails?: string;
          license?: "unknown" | "full" | "occasional" | "free" | "free_restricted" | "full_trial";
          limit?: number;
          role?: "unknown" | "organization_internal_admin" | "organization_internal_user" | "organization_external_user" | "organization_team_guest_user";
      }
      • Optional active?: boolean
      • Optional cursor?: string
      • Optional emails?: string
      • Optional license?: "unknown" | "full" | "occasional" | "free" | "free_restricted" | "full_trial"
      • Optional limit?: number
      • Optional role?: "unknown" | "organization_internal_admin" | "organization_internal_user" | "organization_external_user" | "organization_team_guest_user"

    Returns Promise<{
        body: EnterpriseGetOrganizationMembers200Response;
        response: Response;
    }>

enterpriseGetProject

  • Retrieves project information, such as a name for an existing project.

    Required scope

    projects:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Get project

    Parameters

    • orgId: string

      The ID of the organization from which you want to retrieve the project information.

    • teamId: string

      The ID of the team from which you want to retrieve the project information.

    • projectId: string

      The ID of the project for which you want to retrieve the information.

    Returns Promise<{
        body: Project;
        response: Response;
    }>

enterpriseGetProjectMember

  • Retrieves information for a specific project member.

    Required scope

    projects:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Get project member

    Parameters

    • orgId: string

      The ID of the organization to which the project belongs.

    • teamId: string

      The ID of the team to which the project belongs.

    • projectId: string

      The ID of the project from which you want to retrieve specific member information.

    • memberId: string

      The ID of the member for which you want to retrieve information.

    Returns Promise<{
        body: ProjectMember;
        response: Response;
    }>

enterpriseGetProjectMembers

  • Retrieves the list of members for a specific project.

    Required scope

    projects:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    List of project members

    Parameters

    • orgId: string

      The ID of the organization to which the project belongs.

    • teamId: string

      The ID of the team to which the project belongs.

    • projectId: string

      The ID of the project for which you want to retrieve the list of members.

    • Optional query: {
          cursor?: string;
          limit?: number;
      }
      • Optional cursor?: string
      • Optional limit?: number

    Returns Promise<{
        body: ProjectMemberPage;
        response: Response;
    }>

enterpriseGetProjectSettings

  • Retrieves the project settings.

    Required scope

    projects:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Get project settings

    Parameters

    • orgId: string

      The ID of the organization to which the project belongs.

    • teamId: string

      The ID of the team to which the project belongs.

    • projectId: string

      The ID of the project for which you want to retrieve the project settings.

    Returns Promise<{
        body: ProjectSettings;
        response: Response;
    }>

enterpriseGetProjects

  • 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 permissions, see Content Admin permissions for Company Admins.

    Required scope

    projects:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    List of projects

    Parameters

    • orgId: string

      The ID of the organization from which you want to retrieve the list of available projects.

    • teamId: string

      The ID of the team from which you want to retrieve the list of available projects.

    • Optional query: {
          cursor?: string;
          limit?: number;
      }
      • Optional cursor?: string
      • Optional limit?: number

    Returns Promise<{
        body: ProjectPage;
        response: Response;
    }>

enterpriseGetTeam

  • Retrieves team information for an existing team.

    Required scope

    organizations:teams:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Get team

    Parameters

    • orgId: string

      The id of the Organization.

    • teamId: string

      The id of the Team.

    Returns Promise<{
        body: Team;
        response: Response;
    }>

enterpriseGetTeamMember

  • Retrieves team member by id.

    Required scope

    organizations:teams:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Get team member

    Parameters

    • orgId: string

      The id of the Organization.

    • teamId: string

      The id of the Team.

    • memberId: string

      The id of the Team Member

    Returns Promise<{
        body: TeamMember;
        response: Response;
    }>

enterpriseGetTeamMembers

  • Retrieves team members by cursor.

    Required scope

    organizations:teams:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    List team members

    Parameters

    • orgId: string

      The id of the Organization.

    • teamId: string

      The id of the Team.

    • Optional query: {
          cursor?: string;
          limit?: number;
          role?: string;
      }
      • Optional cursor?: string
      • Optional limit?: number
      • Optional role?: string

    Returns Promise<{
        body: TeamMembersPage;
        response: Response;
    }>

enterpriseGetTeamSettings

  • Retrieves team settings of an existing team.

    Required scope

    organizations:teams:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Get team settings

    Parameters

    • orgId: string

      The id of the Organization.

    • teamId: string

      The id of the Team.

    Returns Promise<{
        body: TeamSettings;
        response: Response;
    }>

enterpriseGetTeams

  • Retrieves list of teams in an existing organization.

    Required scope

    organizations:teams:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    List teams

    Parameters

    • orgId: string

      The id of the Organization.

    • Optional query: {
          cursor?: string;
          limit?: number;
          name?: string;
      }
      • Optional cursor?: string
      • Optional limit?: number
      • Optional name?: string

    Returns Promise<{
        body: TeamsPage;
        response: Response;
    }>

enterpriseInviteTeamMember

  • 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 and an external identity provider, such as Okta or Azure Active Directory.

    Required scope

    organizations:teams:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Invite team members

    Parameters

    • orgId: string

      The id of the Organization.

    • teamId: string

      The id of the Team.

    • teamMemberInvite: TeamMemberInvite

    Returns Promise<{
        body: TeamMember;
        response: Response;
    }>

enterprisePostUserSessionsReset

  • 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. This is useful in situations where a user leaves the company, their credentials are compromised, or there's suspicious activity on their account.

    Required scope

    sessions:delete

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Reset all sessions of a user

    Parameters

    • email: string

      Email ID of the user whose sessions you want to reset. Note that this user will be signed out from all devices.

    Returns Promise<{
        body?: any;
        response: Response;
    }>

enterpriseUpdateProject

  • Update information about a project, such as the project name.

    Required scope

    projects:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Update project

    Parameters

    • orgId: string

      The ID of an Organization.

    • teamId: string

      The ID of a Team.

    • projectId: string

      The ID of a Project.

    • updateProjectRequest: UpdateProjectRequest

    Returns Promise<{
        body: Project;
        response: Response;
    }>

enterpriseUpdateProjectMember

  • Updates details of a project member, such as the member's role.

    Required scope

    projects:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Update project member

    Parameters

    • orgId: string

      The ID of the organization to which the project member belongs.

    • teamId: string

      The ID of the team to which the project member belongs.

    • projectId: string

      The ID of a Project.

    • memberId: string

      The ID of the member whose details you want to update.

    • updateProjectMemberRequest: UpdateProjectMemberRequest

    Returns Promise<{
        body: ProjectMember;
        response: Response;
    }>

enterpriseUpdateProjectSettings

  • Updates the settings of a project.

    Required scope

    projects:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Update project settings

    Parameters

    • orgId: string

      The ID of the organization to which the project belongs.

    • teamId: string

      The ID of the team to which the project belongs.

    • projectId: string

      The ID of the project whose settings you want to update.

    • updateProjectSettingsRequest: UpdateProjectSettingsRequest

    Returns Promise<{
        body: ProjectSettings;
        response: Response;
    }>

enterpriseUpdateTeam

  • Updates an existing team.

    Required scope

    organizations:teams:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Update team

    Parameters

    • orgId: string

      The id of the Organization.

    • teamId: string

      The id of the Team.

    • teamChanges: TeamChanges

    Returns Promise<{
        body: Team;
        response: Response;
    }>

enterpriseUpdateTeamMember

  • Updates team member role in team by id.

    Required scope

    organizations:teams:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Update team member

    Parameters

    • orgId: string

      The id of the Organization.

    • teamId: string

      The id of the Team.

    • memberId: string

      The id of the Team Member

    • teamMemberChanges: TeamMemberChanges

    Returns Promise<{
        body: TeamMember;
        response: Response;
    }>

enterpriseUpdateTeamSettings

  • Updates team settings of an existing team.

    Required scope

    organizations:teams:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Update team settings

    Parameters

    • orgId: string

      The id of the Organization.

    • teamId: string

      The id of the Team.

    • teamSettingsChanges: TeamSettingsChanges

    Returns Promise<{
        body: TeamSettings;
        response: Response;
    }>

getAllGroups

  • 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 that points to the next portion of the results. To retrieve the next portion of the collection, on your next call to the same method, set the cursor parameter equal to the cursor value you received in the response of the previous request.
    For example, if you set the limit query parameter to 10 and the board contains 20 items that are a part of a group, the first call will return information about the first 10 items in the response along with a cursor parameter and value. In this example, let's say the cursor parameter value returned in the response is foo. If you want to retrieve the next set of objects, on your next call to the same method, set the cursor parameter value to foo.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Get all groups on a board

    Parameters

    • boardId: string

      Unique identifier (ID) of the board.

    • Optional query: {
          cursor?: string;
          limit?: number;
      }
      • Optional cursor?: string
      • Optional limit?: number

    Returns Promise<{
        body: GetAllGroups200Response;
        response: Response;
    }>

getAppCardItem

  • Retrieves information for a specific app card item on a board.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Get app card item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to retrieve a specific item.

    • itemId: string

      Unique identifier (ID) of the item that you want to retrieve.

    Returns Promise<{
        body: AppCardItem;
        response: Response;
    }>

getBoardMembers

  • Retrieves a pageable list of members for a board.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Get all board members

    Parameters

    • boardId: string

      Unique identifier (ID) of the board to which the board member belongs.

    • Optional query: {
          limit?: string;
          offset?: string;
      }
      • Optional limit?: string
      • Optional offset?: string

    Returns Promise<{
        body: BoardMembersPagedResponse;
        response: Response;
    }>

getBoards

  • Retrieves a list of boards that the user associated with the access token has access to. You can filter and sort the boards by specifying URL query parameter values. If you are an Enterprise customer and a Company Admin, you can retrieve all boards, including all private boards (boards that haven't been specifically shared with you) by enabling Content Admin permissions. To enable Content Admin permissions, see Content Admin permissions for Company Admins. Note that you only get results instantaneously when you filter by the team_id, project_id, or both the team_id and project_id. If you use any other filter, you need to give a few seconds for the indexing of newly created boards before retrieving boards.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Get boards

    Parameters

    • Optional query: {
          limit?: string;
          offset?: string;
          owner?: string;
          projectId?: string;
          query?: string;
          sort?: "default" | "last_modified" | "last_opened" | "last_created" | "alphabetically";
          teamId?: string;
      }
      • Optional limit?: string
      • Optional offset?: string
      • Optional owner?: string
      • Optional projectId?: string
      • Optional query?: string
      • Optional sort?: "default" | "last_modified" | "last_opened" | "last_created" | "alphabetically"
      • Optional teamId?: string

    Returns Promise<{
        body: BoardsPagedResponse;
        response: Response;
    }>

getCardItem

  • Retrieves information for a specific card item on a board

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Get card item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to retrieve a specific item.

    • itemId: string

      Unique identifier (ID) of the item that you want to retrieve.

    Returns Promise<{
        body: CardItem;
        response: Response;
    }>

getConnector

  • Retrieves information for a specific connector on a board.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Get specific connector

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to retrieve a specific connector.

    • connectorId: string

      Unique identifier (ID) of the connector that you want to retrieve.

    Returns Promise<{
        body: ConnectorWithLinks;
        response: Response;
    }>

getConnectors

  • Retrieves a list of connectors for a specific board. This method returns results using a cursor-based approach. A cursor-paginated method returns a portion of the total set of results based on the limit specified and a cursor that points to the next portion of the results. To retrieve the next portion of the collection, on your next call to the same method, set the cursor parameter equal to the cursor value you received in the response of the previous request. For example, if you set the limit query parameter to 10 and the board contains 20 objects, the first call will return information about the first 10 objects in the response along with a cursor parameter and value. In this example, let's say the cursor parameter value returned in the response is foo. If you want to retrieve the next set of objects, on your next call to the same method, set the cursor parameter value to foo.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Get connectors

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to retrieve a list of connectors.

    • Optional query: {
          cursor?: string;
          limit?: string;
      }
      • Optional cursor?: string
      • Optional limit?: string

    Returns Promise<{
        body: ConnectorsCursorPaged;
        response: Response;
    }>

getDocumentItem

  • Retrieves information for a specific document item on a board

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Get document item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to retrieve a specific item.

    • itemId: string

      Unique identifier (ID) of the item that you want to retrieve.

    Returns Promise<{
        body: DocumentItem;
        response: Response;
    }>

getEmbedItem

  • Retrieves information for a specific embed item on a board.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Get embed item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to retrieve a specific item.

    • itemId: string

      Unique identifier (ID) of the item that you want to retrieve.

    Returns Promise<{
        body: EmbedItem;
        response: Response;
    }>

getFrameItem

  • Retrieves information for a specific frame on a board.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Get frame

    Parameters

    • boardId: string

      Unique identifier (ID) of the board that contains the frame that you want to retrieve

    • itemId: string

      Unique identifier (ID) of the frame that you want to retrieve.

    Returns Promise<{
        body: FrameItem;
        response: Response;
    }>

getGroupById

  • Returns a list of items in a specific group.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2 per item ID

    Summary

    Get a group by its ID

    Parameters

    • boardId: string

      Unique identifier (ID) of the board.

    • groupId: string

      Unique identifier (ID) of the group.

    Returns Promise<{
        body: GroupResponseShort;
        response: Response;
    }>

getImageItem

  • Retrieves information for a specific image item on a board.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Get image item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to retrieve a specific item.

    • itemId: string

      Unique identifier (ID) of the item that you want to retrieve.

    Returns Promise<{
        body: ImageItem;
        response: Response;
    }>

getItems

  • Retrieves a list of items for a specific board. You can retrieve all items on the board, a list of child items inside a parent item, or a list of specific types of items by specifying URL query parameter values. This method returns results using a cursor-based approach. A cursor-paginated method returns a portion of the total set of results based on the limit specified and a cursor that points to the next portion of the results. To retrieve the next portion of the collection, on your next call to the same method, set the cursor parameter equal to the cursor value you received in the response of the previous request. For example, if you set the limit query parameter to 10 and the board contains 20 objects, the first call will return information about the first 10 objects in the response along with a cursor parameter and value. In this example, let's say the cursor parameter value returned in the response is foo. If you want to retrieve the next set of objects, on your next call to the same method, set the cursor parameter value to foo.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Get items on board

    Parameters

    • boardId: string

      Unique identifier (ID) of the board for which you want to retrieve the list of available items.

    • Optional query: {
          cursor?: string;
          limit?: string;
          type?: "embed" | "frame" | "image" | "text" | "document" | "shape" | "app_card" | "sticky_note" | "card" | "preview";
      }
      • Optional cursor?: string
      • Optional limit?: string
      • Optional type?: "embed" | "frame" | "image" | "text" | "document" | "shape" | "app_card" | "sticky_note" | "card" | "preview"

    Returns Promise<{
        body: GenericItemCursorPaged;
        response: Response;
    }>

getItemsByGroupId

  • 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 points to the next portion of the results. To retrieve the next portion of the collection, on your next call to the same method, set the cursor parameter equal to the cursor value you received in the response of the previous request.
    For example, if you set the limit query parameter to 10 and the board contains 20 items that are a part of a group, the first call will return information about the first 10 items (not 10 groups) in the response along with a cursor parameter and value. In this example, let's say the cursor parameter value returned in the response is foo. If you want to retrieve the next set of objects, on your next call to the same method, set the cursor parameter value to foo.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Get items of a group by ID

    Parameters

    • boardId: string

      Unique identifier (ID) of the board.

    • groupItemId: string

      The ID of the group item to retrieve.

    • Optional query: {
          cursor?: string;
          limit?: number;
      }
      • Optional cursor?: string
      • Optional limit?: number

    Returns Promise<{
        body: GetItemsByGroupId200Response;
        response: Response;
    }>

getItemsByTag

  • Retrieves all the items that have the specified tag.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Get items by tag

    Parameters

    • boardIdPlatformTags: string

      Unique identifier (ID) of the board where you want to retrieve a specific tag.

    • tagId: string

      Unique identifier (ID) of the tag that you want to retrieve.

    • Optional query: {
          limit?: string;
          offset?: string;
      }
      • Optional limit?: string
      • Optional offset?: string

    Returns Promise<{
        body: ItemPagedResponse;
        response: Response;
    }>

getItemsExperimental

  • Retrieves a list of items for a specific board. You can retrieve all items on the board, a list of child items inside a parent item, or a list of specific types of items by specifying URL query parameter values. This method returns results using a cursor-based approach. A cursor-paginated method returns a portion of the total set of results based on the limit specified and a cursor that points to the next portion of the results. To retrieve the next portion of the collection, on your next call to the same method, set the cursor parameter equal to the cursor value you received in the response of the previous request. For example, if you set the limit query parameter to 10 and the board contains 20 objects, the first call will return information about the first 10 objects in the response along with a cursor parameter and value. In this example, let's say the cursor parameter value returned in the response is foo. If you want to retrieve the next set of objects, on your next call to the same method, set the cursor parameter value to foo.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Get items on board

    Parameters

    • boardId: string

      Unique identifier (ID) of the board for which you want to retrieve the list of available items.

    • Optional query: {
          cursor?: string;
          limit?: string;
          type?: "shape";
      }
      • Optional cursor?: string
      • Optional limit?: string
      • Optional type?: "shape"

    Returns Promise<{
        body: GenericItemCursorPaged;
        response: Response;
    }>

getItemsWithinFrame

  • 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 on the limit specified and a cursor that points to the next portion of the results. To retrieve the next portion of the collection, on your next call to the same method, set the cursor parameter equal to the cursor value you received in the response of the previous request. For example, if you set the limit query parameter to 10 and the board contains 20 objects, the first call will return information about the first 10 objects in the response along with a cursor parameter and value. In this example, let's say the cursor parameter value returned in the response is foo. If you want to retrieve the next set of objects, on your next call to the same method, set the cursor parameter value to foo.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Get items within frame

    Parameters

    • boardIdPlatformContainers: string

      Unique identifier (ID) of the board that contains the frame for which you want to retrieve the list of available items.

    • parentItemId: string

      ID of the frame for which you want to retrieve the list of available items.

    • Optional query: {
          cursor?: string;
          limit?: string;
          type?: string;
      }
      • Optional cursor?: string
      • Optional limit?: string
      • Optional type?: string

    Returns Promise<{
        body: GenericItemCursorPaged;
        response: Response;
    }>

getMetrics

  • 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 <a href="https://developers.miro.com/?features=appMetricsToken#your-apps\">Your Apps section of Developer Hub.

    Summary

    Get app metrics

    Parameters

    • appId: string

      ID of the app to get metrics for.

    • startDate: string

      Start date of the period in UTC format. For example, 2024-12-31.

    • endDate: string

      End date of the period in UTC format. For example, 2024-12-31.

    • Optional query: {
          period?: "DAY" | "WEEK" | "MONTH";
      }
      • Optional period?: "DAY" | "WEEK" | "MONTH"

    Returns Promise<{
        body: GetMetrics200ResponseInner[];
        response: Response;
    }>

getMetricsTotal

getMindmapNodeExperimental

  • Retrieves information for a specific mind map node on a board.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Get specific mind map node

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to retrieve a mind map node.

    • itemId: string

      Unique identifier (ID) of the mind map node that you want to retrieve.

    Returns Promise<{
        body: MindmapItem;
        response: Response;
    }>

getMindmapNodesExperimental

  • 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 portion of the results. To retrieve the next portion of the collection, on your next call to the same method, set the cursor parameter equal to the cursor value you received in the response of the previous request. For example, if you set the limit query parameter to 10 and the board contains 20 objects, the first call will return information about the first 10 objects in the response along with a cursor parameter and value. In this example, let's say the cursor parameter value returned in the response is foo. If you want to retrieve the next set of objects, on your next call to the same method, set the cursor parameter value to foo.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Get mind map nodes

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to retrieve mind map nodes.

    • Optional query: {
          cursor?: string;
          limit?: string;
      }
      • Optional cursor?: string
      • Optional limit?: string

    Returns Promise<{
        body: MindmapCursorPaged;
        response: Response;
    }>

getShapeItem

  • Retrieves information for a specific shape item on a board.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Get shape item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to retrieve a specific item.

    • itemId: string

      Unique identifier (ID) of the item that you want to retrieve.

    Returns Promise<{
        body: ShapeItem;
        response: Response;
    }>

getShapeItemFlowchart

  • Retrieves information for a specific shape item on a board.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Get shape item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to retrieve a specific item.

    • itemId: string

      Unique identifier (ID) of the item that you want to retrieve.

    Returns Promise<{
        body: ShapeItem;
        response: Response;
    }>

getSpecificBoard

  • Retrieves information about a board.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Get specific board

    Parameters

    • boardId: string

      Unique identifier (ID) of the board that you want to retrieve.

    Returns Promise<{
        body: BoardWithLinksAndLastOpened;
        response: Response;
    }>

getSpecificBoardMember

  • Retrieves information for a board member.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Get specific board member

    Parameters

    • boardId: string

      Unique identifier (ID) of the board to which the board member belongs.

    • boardMemberId: string

      Unique identifier (ID) of the board member whose role you want to retrieve.

    Returns Promise<{
        body: BoardMemberWithLinks;
        response: Response;
    }>

getSpecificItem

  • Retrieves information for a specific item on a board.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Get specific item on board

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to retrieve a specific item.

    • itemId: string

      Unique identifier (ID) of the item that you want to retrieve.

    Returns Promise<{
        body: GenericItem;
        response: Response;
    }>

getSpecificItemExperimental

  • Retrieves information for a specific item on a board.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Get specific item on board

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to retrieve a specific item.

    • itemId: string

      Unique identifier (ID) of the item that you want to retrieve.

    Returns Promise<{
        body: GenericItem;
        response: Response;
    }>

getStickyNoteItem

  • Retrieves information for a specific sticky note item on a board.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Get sticky note item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to retrieve a specific item.

    • itemId: string

      Unique identifier (ID) of the item that you want to retrieve.

    Returns Promise<{
        body: StickyNoteItem;
        response: Response;
    }>

getSubscriptionById

  • Retrieves information for a specific webhook subscription.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Get specific webhook subscription

    Parameters

    • subscriptionId: string

      Unique identifier (ID) of the subscription that you want to retrieve

    Returns Promise<{
        body: GenericSubscription;
        response: Response;
    }>

getTag

  • Retrieves information for a specific tag.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Get tag

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to retrieve a specific tag.

    • tagId: string

      Unique identifier (ID) of the tag that you want to retrieve.

    Returns Promise<{
        body: TagWithLinks;
        response: Response;
    }>

getTagsFromBoard

  • Retrieves all the tags from the specified board.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Get tags from board

    Parameters

    • boardId: string

      Unique identifier (ID) of the board whose tags you want to retrieve.

    • Optional query: {
          limit?: string;
          offset?: string;
      }
      • Optional limit?: string
      • Optional offset?: string

    Returns Promise<{
        body: TagsPagedResponse;
        response: Response;
    }>

getTagsFromItem

  • Retrieves all the tags from the specified item.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Get tags from item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board with the item whose tags you want to retrieve.

    • itemId: string

      Unique identifier (ID) of the item whose tags you want to retrieve.

    Returns Promise<{
        body: GetTagsResponse;
        response: Response;
    }>

getTextItem

  • Retrieves information for a specific text item on a board.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Get text item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to retrieve a specific item.

    • itemId: string

      Unique identifier (ID) of the item that you want to retrieve.

    Returns Promise<{
        body: TextItem;
        response: Response;
    }>

getUserSubscriptions

  • Retrieves information about all webhook subscriptions for a specific user.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 4

    Summary

    Get webhook subscriptions

    Parameters

    • Optional query: {
          cursor?: string;
          limit?: string;
      }
      • Optional cursor?: string
      • Optional limit?: string

    Returns Promise<{
        body: GenericSubscriptionsCursorPaged;
        response: Response;
    }>

removeBoardMember

  • Removes a board member from a board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Remove board member

    Parameters

    • boardId: string

      Unique identifier (ID) of the board from which you want to delete an item.

    • boardMemberId: string

      Unique identifier (ID) of the board member whose role you want to delete.

    Returns Promise<{
        body: object;
        response: Response;
    }>

removeTagFromItem

  • 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 applies to the following endpoints: Attach tag to item, Update tag, Delete tag.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Remove tag from item

    Parameters

    • boardIdPlatformTags: string

      Unique identifier (ID) of the board with the item that you want to remove a tag from.

    • itemId: string

      Unique identifier (ID) of the item that you want to remove the tag from.

    • tagId: string

      Unique identifier (ID) of the tag that you want to remove from the item.

    Returns Promise<{
        body: object;
        response: Response;
    }>

revokeToken

  • 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.

    Summary

    Revoke token

    Parameters

    • accessToken: string

      Access token that you want to revoke

    Returns Promise<{
        body?: any;
        response: Response;
    }>

shareBoard

  • 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.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Summary

    Share board

    Parameters

    • boardId: string

      Unique identifier (ID) of the board to which the board member belongs.

    • boardMembersInvite: BoardMembersInvite

    Returns Promise<{
        body: InvitationResult;
        response: Response;
    }>

tokenInfo

  • 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.

    Summary

    Get access token information

    Returns Promise<{
        body: TokenInformation;
        response: Response;
    }>

unGroup

  • Ungroups items from a group.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Summary

    Ungroup items

    Parameters

    • boardId: string

      Unique identifier (ID) of the board.

    • groupId: string

      Unique identifier (ID) of the group.

    • Optional query: {
          deleteItems?: boolean;
      }
      • Optional deleteItems?: boolean

    Returns Promise<{
        body: object;
        response: Response;
    }>

updateAppCardItem

  • 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

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Update app card item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to update the item.

    • itemId: string

      Unique identifier (ID) of the item that you want to update.

    • appCardUpdateRequest: AppCardUpdateRequest

    Returns Promise<{
        body: AppCardItem;
        response: Response;
    }>

updateBoard

  • Updates a specific board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Update board

    Parameters

    • boardId: string

      Unique identifier (ID) of the board that you want to update.

    • boardChanges: BoardChanges

    Returns Promise<{
        body: BoardWithLinks;
        response: Response;
    }>

updateBoardMember

  • Updates the role of a board member.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Update board member

    Parameters

    • boardId: string

      Unique identifier (ID) of the board for which you want to update the role of the board member.

    • boardMemberId: string

      Unique identifier (ID) of the board member whose role you want to update.

    • boardMemberChanges: BoardMemberChanges

    Returns Promise<{
        body: BoardMemberWithLinks;
        response: Response;
    }>

updateBoardSubscription

  • Updates the status or the callback URL of an existing webhook subscription.

    Required scope

    boards:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Update webhook subscription

    Parameters

    Returns Promise<{
        body: BoardSubscription;
        response: Response;
    }>

updateCardItem

  • 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

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Update card item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to update the item.

    • itemId: string

      Unique identifier (ID) of the item that you want to update.

    • cardUpdateRequest: CardUpdateRequest

    Returns Promise<{
        body: CardItem;
        response: Response;
    }>

updateConnector

  • Updates a connector on a board based on the data and style properties provided in the request body.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Update connector

    Parameters

    • boardId: string

      Unique identifier (ID) of the board for which you want to update the connector.

    • connectorId: string

      Unique identifier (ID) of the connector that you want to update.

    • connectorChangesData: ConnectorChangesData

    Returns Promise<{
        body: ConnectorWithLinks;
        response: Response;
    }>

updateDocumentItemUsingFileFromDevice

  • Updates a document item on a board by using file from a device.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Update document item using file from device

    Parameters

    • boardIdPlatformFileUpload: string

      Unique identifier (ID) of the board where you want to update the item.

    • itemId: string

      Unique identifier (ID) of the item that you want to update.

    • resource: RequestFile

      Select a file to upload. Maximum file size is 6 MB.

    • Optional data: UploadFileFromDeviceData

    Returns Promise<{
        body: DocumentItem;
        response: Response;
    }>

updateDocumentItemUsingUrl

  • Updates a document item on a board

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Update document item using URL

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to update the item.

    • itemId: string

      Unique identifier (ID) of the item that you want to update.

    • documentUpdateRequest: DocumentUpdateRequest

    Returns Promise<{
        body: DocumentItem;
        response: Response;
    }>

updateEmbedItem

  • Updates an embed item on a board based on the data properties provided in the request body.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Update embed item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to update the item.

    • itemId: string

      Unique identifier (ID) of the item that you want to update.

    • embedUpdateRequest: EmbedUpdateRequest

    Returns Promise<{
        body: EmbedItem;
        response: Response;
    }>

updateFrameItem

  • 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

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Update frame

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to update the frame.

    • itemId: string

      Unique identifier (ID) of the frame that you want to update.

    • frameUpdateRequest: FrameUpdateRequest

    Returns Promise<{
        body: FrameItem;
        response: Response;
    }>

updateGroup

  • 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

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Updates a group with new items

    Parameters

    • boardId: string

      Unique identifier (ID) of the board.

    • groupId: string

      Unique identifier (ID) of the group.

    • group: Group

    Returns Promise<{
        body: GroupResponseShort;
        response: Response;
    }>

updateImageItemUsingFileFromDevice

  • Updates an image item on a board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Update image item using file from device

    Parameters

    • boardIdPlatformFileUpload: string

      Unique identifier (ID) of the board where you want to update the item.

    • itemId: string

      Unique identifier (ID) of the item that you want to update.

    • resource: RequestFile

      Select a file to upload. Maximum file size is 6 MB.

    • Optional data: UploadFileFromDeviceData

    Returns Promise<{
        body: ImageItem;
        response: Response;
    }>

updateImageItemUsingUrl

  • Updates an image item on a board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Update image item using URL

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to update the item.

    • itemId: string

      Unique identifier (ID) of the item that you want to update.

    • imageUpdateRequest: ImageUpdateRequest

    Returns Promise<{
        body: ImageItem;
        response: Response;
    }>

updateItemPositionOrParent

  • Updates the position or the parent of an item on a board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Update item position or parent

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to update the item.

    • itemId: string

      Unique identifier (ID) of the item that you want to update.

    • genericItemUpdate: GenericItemUpdate

    Returns Promise<{
        body: GenericItem;
        response: Response;
    }>

updateShapeItem

  • 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

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Update shape item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to update the item.

    • itemId: string

      Unique identifier (ID) of the item that you want to update.

    • shapeUpdateRequest: ShapeUpdateRequest

    Returns Promise<{
        body: ShapeItem;
        response: Response;
    }>

updateShapeItemFlowchart

  • 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

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Update shape item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to update the item.

    • itemId: string

      Unique identifier (ID) of the item that you want to update.

    • shapeUpdateRequest: ShapeUpdateRequest

    Returns Promise<{
        body: ShapeItem;
        response: Response;
    }>

updateStickyNoteItem

  • 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

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Update sticky note item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to update the item.

    • itemId: string

      Unique identifier (ID) of the item that you want to update.

    • stickyNoteUpdateRequest: StickyNoteUpdateRequest

    Returns Promise<{
        body: StickyNoteItem;
        response: Response;
    }>

updateTag

  • 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 following endpoints: Attach tag to item, Remove tag from item, Delete tag.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Update tag

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to update a specific tag.

    • tagId: string

      Unique identifier (ID) of the tag that you want to update.

    • tagUpdateRequest: TagUpdateRequest

    Returns Promise<{
        body: TagWithLinks;
        response: Response;
    }>

updateTextItem

  • 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

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Update text item

    Parameters

    • boardId: string

      Unique identifier (ID) of the board where you want to update the item.

    • itemId: string

      Unique identifier (ID) of the item that you want to update.

    • textUpdateRequest: TextUpdateRequest

    Returns Promise<{
        body: TextItem;
        response: Response;
    }>

@mirohq/miro-api