Miro

Miro is an online collaborative whiteboard used by distributed teams for brainstorming, diagramming, and workshops. The Miro REST API exposes boards, board items (sticky notes, cards, shapes, frames, images, embeds, etc.), connectors, tags, mind maps, members, organizations, teams, webhooks, audit logs, and SCIM provisioning. Miro also offers a Web SDK for in-board apps.

12 APIs 0 Features
ProductivityWhiteboardVisual CollaborationDiagrammingSaaS

APIs

Miro Boards API

Create, read, update, copy, and delete Miro boards. Boards are the top-level container for whiteboard content within a team or workspace.

Miro Board Items API

Generic and per-type endpoints for board items: sticky notes, cards, shapes, text, frames, images, documents, embeds, and app cards. CRUD on items, with type-specific create/upd...

Miro Connectors API

Create and manage connectors (lines/arrows) between board items, including style and shape options for diagramming workflows.

Miro Tags API

Create, attach, and remove tags on board items for searching, filtering, and grouping.

Miro Mind Map API

Create and manage mind-map nodes and parent-child relationships on a board.

Miro Board Members API

Manage who has access to a board and what role (owner, editor, commenter, viewer) they hold.

Miro Webhooks API

Subscribe to board events (item created/updated/deleted, board events) and receive HTTP callbacks at your endpoint.

Miro Organization API

Enterprise-only endpoints to manage the organization, list members, and inspect organization-wide membership and licensing.

Miro Teams API

Manage teams, team members, team settings, and default team roles within an organization.

Miro Audit Logs API

Enterprise audit-log endpoints. Query user, board, and admin actions for compliance and security monitoring.

Miro SCIM API

SCIM 2.0 provisioning for Enterprise customers. Automate user/group lifecycle from Okta, Azure AD, OneLogin, and other IdPs.

Miro Web SDK

Build apps that run inside the Miro board UI. The Web SDK lets your app create and modify board items, react to events, render custom panels, and integrate with the user's works...

Collections

Pricing Plans

Miro Plans Pricing

4 plans

PLANS

Rate Limits

Miro Rate Limits

4 limits

RATE LIMITS

FinOps

Miro Finops

FINOPS

Resources

🔗
LinkedIn
LinkedIn
🔗
Website
Website
🌐
DeveloperPortal
DeveloperPortal
💰
Pricing
Pricing
👥
GitHub
GitHub
🔗
Plans
Plans
🔗
RateLimits
RateLimits
🔗
FinOps
FinOps

Sources

Raw ↑
opencollection: 1.0.0
info:
  name: Miro Developer Platform
  version: v2.0
items:
- info:
    name: tokens
    type: folder
  items:
  - info:
      name: Revoke token (v1)
      type: http
    http:
      method: POST
      url: https://api.miro.com/v1/oauth/revoke
      params:
      - name: access_token
        value: ''
        type: query
        description: Access token that you want to revoke
    docs: <p><b>Please use the new revoke endpoint <code>/v2/oauth/revoke</code>. This endpoint is considered vulnerable and
      deprecated due to access token passed publicly in the URL.</b></p> 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.
  - info:
      name: Get access token information
      type: http
    http:
      method: GET
      url: https://api.miro.com/v1/oauth-token
    docs: 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.
- info:
    name: AI Interaction Logs
    type: folder
  items:
  - info:
      name: Get AI interaction logs (Beta)
      type: http
    http:
      method: GET
      url: https://api.miro.com/v2/orgs/:org_id/ai-interaction-logs
      params:
      - name: org_id
        value: '3074457345821141000'
        type: path
        description: Unique identifier of the organization.
      - name: object_ids
        value: 3458764549483493025,u8J_kllZmDk=
        type: query
        description: "List of object IDs used to retrieve AI interaction logs. \nCurrently, supported object types include\
          \ board IDs and organization IDs. \nYou can obtain object IDs from the response of this endpoint (the <code>object.id</code>\
          \ field), \nfrom other Platform API endpoints (for example, [Get boards API](https://developers.miro.com/reference/get-boards)),\
          \ \nor from Miro UI URLs (board ID and organization ID from the URLs).\n"
      - name: emails
        value: someone@domain.com,someoneelse@domain.com
        type: query
        description: Filters AI interaction logs using a list of user emails. Only AI interactions associated with the provided
          emails will be included in the response.
      - name: from
        value: '2026-01-30T17:26:50Z'
        type: query
        description: 'Start date and time of the time range used to filter AI interaction logs. Only interactions that were
          stored within the specified <code>from</code> - <code>to</code> time range are returned.

          Format: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).

          '
      - name: to
        value: '2036-03-30T17:26:50Z'
        type: query
        description: 'End date and time of the time range used to filter AI interaction logs. Only interactions that were
          stored within the specified <code>from</code> - <code>to</code> time range are returned.

          Format: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).

          '
      - name: cursor
        value: MTY2OTg4NTIwMDAwMHwxMjM=
        type: query
        description: '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, set
          the cursor parameter equal to the cursor value you received in the response of the previous request.

          '
      - name: limit
        value: '100'
        type: query
        description: 'The maximum number of results to return per call. If the number of logs in the response is greater than
          the limit specified, the response returns the cursor parameter with a value.

          '
      - name: sorting
        value: asc
        type: query
        description: 'Sort order in which you want to view the result set based on the interaction date. To sort by an ascending
          date, specify `asc`. To sort by a descending date, specify `desc`.

          '
    docs: 'Retrieves AI interaction logs for your organization. AI interaction logs capture user interactions with AI features
      in Miro. You can retrieve results for a specific time period. You can also filter results based on object IDs and the
      emails of users who interacted with AI features. Additionally, results can be paginated for easier viewing and processing.

      <br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>aiinteractionlogs:read</a>

      <br/><h3>Rate limiti'
- info:
    name: Audit Logs
    type: folder
  items:
  - info:
      name: Get audit logs
      type: http
    http:
      method: GET
      url: https://api.miro.com/v2/audit/logs
      params:
      - name: createdAfter
        value: '2023-03-30T17:26:50.000Z'
        type: query
        description: '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](https://en.wikipedia.org/wiki/ISO_8601), including milliseconds and a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC))."

          '
      - name: createdBefore
        value: '2023-04-30T17:26:50.000Z'
        type: query
        description: '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](https://en.wikipedia.org/wiki/ISO_8601), including milliseconds and a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).

          '
      - name: cursor
        value: ''
        type: query
        description: 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 set of results of the collection,
          set the `cursor` parameter in your next request to the appropriate cursor value returned in the response.
      - name: limit
        value: '100'
        type: query
        description: 'Maximum number of results returned based on the `limit` specified in the request. For example, if there
          are `30` results, the request has no `cursor` value, and the `limit` is set to `20`,the `size` of the results will
          be `20`. The rest of the results will not be returned. To retrieve the rest of the results, you must make another
          request and set the appropriate value for the `cursor` parameter value that  you obtained from the response.<br>Default:
          `100`

          '
      - name: sorting
        value: ASC
        type: query
        description: 'Sort order in which you want to view the result set. Based on the value you provide, the results are
          sorted in an ascending or descending order of the audit log creation date (audit log `createdAt` parameter).<br>Default:
          `ASC`

          '
    docs: Retrieves a page of audit events from the last 90 days. If you want to retrieve data that is older than 90 days,
      you can use the <a target=_blank href="https://help.miro.com/hc/en-us/articles/360017571434-Audit-logs#h_01J7EY4E0F67EFTRQ7BT688HW0">CSV
      export feature</a>.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>auditlogs:read</a>
      <br/><h3>Rate limiting</h3> <a target=_blank href="/reference/rate-limiting#rate-limit-tiers">Level 2</a>
- info:
    name: 'Board classification: Organization level'
    type: folder
  items:
  - info:
      name: Get organization settings
      type: http
    http:
      method: GET
      url: https://api.miro.com/v2/orgs/:org_id/data-classification-settings
      params:
      - name: org_id
        value: '3074457345821141000'
        type: path
        description: id of the organization
    docs: Retrieves board classification settings for an existing organization.<br/><h3>Required scope</h3> <a target=_blank
      href=https://developers.miro.com/reference/scopes>organizations:read</a> <br/><h3>Rate limiting</h3> <a target=_blank
      href="/reference/rate-limiting#rate-limit-tiers">Level 2</a> <br/><h3>Enterprise only</h3> <p>This API is available
      only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan</a> users. You can only use
      this endpoint if you have the rol
- info:
    name: 'Board classification: Team level'
    type: folder
  items:
  - info:
      name: Bulk update boards classification
      type: http
    http:
      method: PATCH
      url: https://api.miro.com/v2/orgs/:org_id/teams/:team_id/data-classification
      params:
      - name: org_id
        value: '3074457345821141000'
        type: path
        description: id of the organization
      - name: team_id
        value: '3074457345618265000'
        type: path
        description: id of the team
      body:
        type: json
        data: '{}'
    docs: 'Updates board classification for not-classified only or all boards in an existing team.<br/><h3>Required scope</h3>
      <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a> <br/><h3>Rate limiting</h3> <a target=_blank
      href="/reference/rate-limiting#rate-limit-tiers">Level 4</a> <br/><h3>Enterprise only</h3> <p>This API is available
      only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan</a> users. You can only use
      this endpoint if you '
  - info:
      name: Get team settings
      type: http
    http:
      method: GET
      url: https://api.miro.com/v2/orgs/:org_id/teams/:team_id/data-classification-settings
      params:
      - name: org_id
        value: '3074457345821141000'
        type: path
        description: id of the organization
      - name: team_id
        value: '3074457345618265000'
        type: path
        description: id of the team
    docs: 'Retrieves board classification settings for an existing team.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>organizations:teams:read</a>
      <br/><h3>Rate limiting</h3> <a target=_blank href="/reference/rate-limiting#rate-limit-tiers">Level 2</a> <br/><h3>Enterprise
      only</h3> <p>This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise
      plan</a> users. You can only use this endpoint if you have the role '
  - info:
      name: Update team settings
      type: http
    http:
      method: PATCH
      url: https://api.miro.com/v2/orgs/:org_id/teams/:team_id/data-classification-settings
      params:
      - name: org_id
        value: '3074457345821141000'
        type: path
        description: id of the organization
      - name: team_id
        value: '3074457345618265000'
        type: path
        description: id of the team
      body:
        type: json
        data: '{}'
    docs: Updates board classification settings for an existing team.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>organizations:teams:write</a>
      <br/><h3>Rate limiting</h3> <a target=_blank href="/reference/rate-limiting#rate-limit-tiers">Level 2</a> <br/><h3>Enterprise
      only</h3> <p>This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise
      plan</a> users. You can only use this endpoint if you have the role o
- info:
    name: 'Board classification: Board level'
    type: folder
  items:
  - info:
      name: Get board classification
      type: http
    http:
      method: GET
      url: https://api.miro.com/v2/orgs/:org_id/teams/:team_id/boards/:board_id/data-classification
      params:
      - name: org_id
        value: '3074457345821141000'
        type: path
        description: id of the organization
      - name: team_id
        value: '3074457345618265000'
        type: path
        description: id of the team
      - name: board_id
        value: o9J_kzlUDmo=
        type: path
        description: Unique identifier of the board that you want to retrieve.
    docs: Retrieves board classification for a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:read</a>
      <br/><h3>Rate limiting</h3> <a target=_blank href="/reference/rate-limiting#rate-limit-tiers">Level 2</a> <br/><h3>Enterprise
      only</h3> <p>This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise
      plan</a> users. You can only use this endpoint if you have the role of a Company Admin. You can req
  - info:
      name: Update board classification
      type: http
    http:
      method: POST
      url: https://api.miro.com/v2/orgs/:org_id/teams/:team_id/boards/:board_id/data-classification
      params:
      - name: org_id
        value: '3074457345821141000'
        type: path
        description: id of the organization
      - name: team_id
        value: '3074457345618265000'
        type: path
        description: id of the team
      - name: board_id
        value: o9J_kzlUDmo=
        type: path
        description: Unique identifier of the board that you want to update.
      body:
        type: json
        data: '{}'
    docs: Updates board classification for an existing board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>
      <br/><h3>Rate limiting</h3> <a target=_blank href="/reference/rate-limiting#rate-limit-tiers">Level 2</a> <br/><h3>Enterprise
      only</h3> <p>This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise
      plan</a> users. You can only use this endpoint if you have the role of a Company Admin. Yo
- info:
    name: doc formats
    type: folder
  items:
  - info:
      name: Create doc format item
      type: http
    http:
      method: POST
      url: https://api.miro.com/v2/boards/:board_id/docs
      params:
      - name: board_id
        value: ''
        type: path
        description: Unique identifier (ID) of the board where you want to create the item.
      body:
        type: json
        data: '{}'
    docs: Adds a doc format item to a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>
      <br/><h3>Rate limiting</h3> <a target=_blank href="/reference/rate-limiting#rate-limit-tiers">Level 2</a><br/>
  - info:
      name: Get doc format item
      type: http
    http:
      method: GET
      url: https://api.miro.com/v2/boards/:board_id/docs/:item_id
      params:
      - name: board_id
        value: ''
        type: path
        description: Unique identifier (ID) of the board from which you want to retrieve a specific item.
      - name: item_id
        value: ''
        type: path
        description: Unique identifier (ID) of the item that you want to retrieve.
      - name: textContentType
        value: ''
        type: query
        description: Controls the contentType of the returned doc's content.
    docs: Retrieves information for a specific doc format item on a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:read</a>
      <br/><h3>Rate limiting</h3> <a target=_blank href="/reference/rate-limiting#rate-limit-tiers">Level 1</a><br/>
  - info:
      name: Delete doc format item
      type: http
    http:
      method: DELETE
      url: https://api.miro.com/v2/boards/:board_id/docs/:item_id
      params:
      - name: board_id
        value: ''
        type: path
        description: Unique identifier (ID) of the board from which you want to delete the item.
      - name: item_id
        value: ''
        type: path
        description: Unique identifier (ID) of the item that you want to delete.
    docs: Deletes a doc format item from the board<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a>
      <br/><h3>Rate limiting</h3> <a target=_blank href="/reference/rate-limiting#rate-limit-tiers">Level 3</a><br/>
- info:
    name: Legal holds
    type: folder
  items:
  - info:
      name: Get all cases
      type: http
    http:
      method: GET
      url: https://api.miro.com/v2/orgs/:org_id/cases
      params:
      - name: limit
        value: '10'
        type: query
        description: The maximum number of items in the result list.
      - name: cursor
        value: MTY2OTg4NTIwMDAwMHwxMjM=
        type: query
        description: 'An indicator of the position of a page in the full set of results. To obtain the first page leave it
          empty. To obtain subsequent pages set it to the value returned in the cursor field of the previous request.

          '
      - name: org_id
        value: '3074457345618265000'
        type: path
        description: The ID of the organization for which you want to retrieve the list of cases.
    docs: Retrieves the list of eDiscovery cases in an organization.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>organization:cases:management</a>
      <br/><h3>Rate limiting</h3> <a target=_blank href="/reference/rate-limiting#rate-limit-tiers">Level 4</a> <br/><h3>Enterprise
      Guard only</h3> <p>This API is available only for Enterprise plan users with the <a target=_blank href="https://help.miro.com/hc/en-us/articles/15699815402514-Enterprise-Guard-overview">
  - info:
      name: Create case
      type: http
    http:
      method: POST
      url: https://api.miro.com/v2/orgs/:org_id/cases
      params:
      - name: org_id
        value: '3074457345618265000'
        type: path
        description: The ID of the organization in which you want to create a new case.
      body:
        type: json
        data: '{}'
    docs: Creating a case for legal hold is the first critical step in the eDiscovery process when litigation or an investigation
      is anticipated. One of the purposes of creating a case is that it acts as a container that allows admins to group multiple
      legal holds under one case. For more information, see our <a href="https://help.miro.com/hc/en-us/articles/22120022370962-Create-a-case"
      target=_blank>Help Center page on creating a case</a>. <br><br>This API creates a new case in an organization.<br/><h3>R
  - info:
      name: Get case
      type: http
    http:
      method: GET
      url: https://api.miro.com/v2/orgs/:org_id/cases/:case_id
      params:
      - name: org_id
        value: '3074457345618265000'
        type: path
        description: The ID of the organization for which you want to retrieve the case information.
      - name: case_id
        value: '3074457345619012007'
        type: path
        description: The ID of the case you want to retrieve.
    docs: Retrieves information about a case in an organization.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>organization:cases:management</a>
      <br/><h3>Rate limiting</h3> <a target=_blank href="/reference/rate-limiting#rate-limit-tiers">Level 3</a> <br/><h3>Enterprise
      Guard only</h3> <p>This API is available only for Enterprise plan users with the <a target=_blank href="https://help.miro.com/hc/en-us/articles/15699815402514-Enterprise-Guard-overview">Ente
  - info:
      name: Edit case
      type: http
    http:
      method: PUT
      url: https://api.miro.com/v2/orgs/:org_id/cases/:case_id
      params:
      - name: org_id
        value: '3074457345618265000'
        type: path
        description: The ID of the organization for which you want to edit the case information.
      - name: case_id
        value: '3074457345619012007'
        type: path
        description: The ID of the case you want to edit.
      body:
        type: json
        data: '{}'
    docs: 'Editing a case allows eDiscovery Admins to keep case details accurate and aligned with the evolving scope of a
      legal matter. As investigations progress, it may be necessary to update the case name or description to reflect changes
      in focus, terminology, or internal documentation standards. Since a case serves as the central container for one or
      more legal holds, keeping its information up to date helps ensure clarity, consistency, and easier navigation for all
      stakeholders involved in the legal '
  - info:
      name: Close case
      type: http
    http:
      method: DELETE
      url: https://api.miro.com/v2/orgs/:org_id/cases/:case_id
      params:
      - name: org_id
        value: '3074457345618265000'
        type: path
        description: The ID of the organization in which you want to close a case.
      - name: case_id
        value: '3074457345618265000'
        type: path
        description: The ID of the case you want to close.
    docs: Closing a case is the final stage in the eDiscovery process, marking the conclusion of a legal matter or investigation.
      You must ensure that all associated legal holds within the case are closed before closing the case. Closing a case will
      permanently delete it. For more information, see our <a href="https://help.miro.com/hc/en-us/articles/22138936297746-Close-a-case"
      target=_blank>Help Center page on closing a case</a>. <br><br>This API closes a case in an organization.<br/><h3>Required
      scope</
  - info:
      name: Get all legal holds within a case
      type: http
    http:
      method: GET
      url: https://api.miro.com/v2/orgs/:org_id/cases/:case_id/legal-holds
      params:
      - name: limit
        value: '10'
        type: query
        description: The maximum number of items in the result list.
      - name: cursor
        value: MTY2OTg4NTIwMDAwMHwxMjM=
        type: query
        description: 'An indicator of the position of a page in the full set of results. To obtain the first page leave it
          empty. To obtain subsequent pages set it to the value returned in the cursor field of the previous request.

          '
      - name: org_id
        value: '3074457345618265000'
        type: path
        description: The ID of the organization for which you want to retrieve the list of legal holds within a case.
      - name: case_id
        value: '3074457345619012007'
        type: path
        description: The ID of the case for which you want to retrieve the list of legal holds.
    docs: Retrieves the list of all legal holds within a case for an organization.<br/><h3>Required scope</h3> <a target=_blank
      href=https://developers.miro.com/reference/scopes>organization:cases:management</a> <br/><h3>Rate limiting</h3> <a target=_blank
      href="/reference/rate-limiting#rate-limit-tiers">Level 4</a> <br/><h3>Enterprise Guard only</h3> <p>This API is available
      only for Enterprise plan users with the <a target=_blank href="https://help.miro.com/hc/en-us/articles/15699815402514-Enterprise-Gu
  - info:
      name: Create legal hold
      type: http
    http:
      method: POST
      url: https://api.miro.com/v2/orgs/:org_id/cases/:case_id/legal-holds
      params:
      - name: org_id
        value: '3074457345618265000'
        type: path
        description: The ID of the organization in which you want to create a new legal hold.
      - name: case_id
        value: '3074457345619012007'
        type: path
        description: The ID of the case in which you want to create a new legal hold.
      body:
        type: json
        data: '{}'
    docs: After creating a case it is possible to add one or multiple legal holds to the case. Creating a legal hold involves
      identifying the relevant users associated with a case and applying the hold to prevent permanent deletion of content
      that those users own, co-own, create, edit or access. For more information, see our <a href="https://help.miro.com/hc/en-us/articles/22120471564946-Add-a-legal-hold-to-a-case"
      target=_blank>Help Center page on adding a legal hold to a case</a>. <br><br>This API creat
  - info:
      name: Get board export jobs of a case
      type: http
    http:
      method: GET
      url: https://api.miro.com/v2/orgs/:org_id/cases/:case_id/export-jobs
      params:
      - name: limit
        value: '10'
        type: query
        description: The maximum number of items in the result list.
      - name: cursor
        value: MTY2OTg4NTIwMDAwMHwxMjM=
        type: query
        description: 'An indicator of the position of a page in the full set of results. To obtain the first page leave it
          empty. To obtain subsequent pages set it to the value returned in the cursor field of the previous request.

          '
      - name: org_id
        value: '3074457345618265000'
        type: path
        description: The ID of the organization for which you want to retrieve the list of export jobs within a case.
      - name: case_id
        value: '3074457345619012007'
        type: path
        description: The ID of the case for which you want to retrieve the list of export jobs.
    docs: Retrieves board export jobs for a case.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>organization:cases:management</a>
      <br/><h3>Rate limiting</h3> <a target=_blank href="/reference/rate-limiting#rate-limit-tiers">Level 4</a> <br/><h3>Enterprise
      Guard only</h3> <p>This API is available only for Enterprise plan users with the <a target=_blank href="https://help.miro.com/hc/en-us/articles/15699815402514-Enterprise-Guard-overview">Enterprise
      Guard ad
  - info:
      name: Get legal hold information
      type: http
    http:
      method: GET
      url: https://api.miro.com/v2/orgs/:org_id/cases/:case_id/legal-holds/:legal_hold_id
      params:
      - name: org_id
        value: '3074457345618265000'
        type: path
        description: The ID of the organization for which you want to retrieve the legal hold information.
      - name: case_id
        value: '3074457345619012007'
        type: path
        description: The ID of the case for which you want to retrieve the legal hold information.
      - name: legal_hold_id
        value: '3074457345619013003'
        type: path
        description: The ID of the legal hold you want to retrieve.
    docs: Retrieves information about a legal hold within a case for an organization. <br/><h3>Required scope</h3> <a target=_blank
      href=https://developers.miro.com/reference/scopes>organization:cases:management</a> <br/><h3>Rate limiting</h3> <a target=_blank
      href="/reference/rate-limiting#rate-limit-tiers">Level 3</a> <br/><h3>Enterprise Guard only</h3> <p>This API is available
      only for Enterprise plan users with the <a target=_blank href="https://help.miro.com/hc/en-us/articles/15699815402514-Enterpris
  - info:
      name: Edit legal hold
      type: http
    http:
      method: PUT
      url: https://api.miro.com/v2/orgs/:org_id/cases/:case_id/legal-holds/:legal_hold_id
      params:
      - name: org_id
        value: '3074457345618265000'
        type: path
        description: The ID of the organization for which you want to edit the legal hold information.
      - name: case_id
        value: '3074457345619012007'
        type: path
        description: The ID of the case for which you want to edit the legal hold information.
      - name: legal_hold_id
        value: '3074457345619013003'
        type: path
        description: The ID of the legal hold you want to edit.
      body:
        type: json
        data: '{}'
    docs: Editing a legal hold allows eDiscovery Admins to adjust and refine ongoing legal preservation efforts as case requirements
      evolve. Whether new custodians are identified, additional Miro boards become relevant, or existing boards or users are
      no longer in scope, editing a legal hold ensures that the correct data remains preserved and defensible throughout the
      legal process. Admins can update the legal hold’s name or description and add or remove users and boards as needed.
      This flexibility suppor
  - info:
      name: Close legal hold
      type: http
    http:
      method: DELETE
      url: https://api.miro.com/v2/orgs/:org_id/cases/:case_id/legal-holds/:legal_hold_id
      params:
      - name: org_id
        value: '3074457345618265000'
        type: path
        description: The ID of the organization in which you want to close a legal hold.
      - name: case_id
        value: '3074457345619012007'
        type: path
        description: The ID of the case in which you want to close a legal hold.
      - name: legal_hold_id
        value: '3074457345619013003'
        type: path
        description: The ID of the legal hold you want to close.
    docs: Closing a legal hold is one of the final steps in the eDiscovery process once the litigation or investigation has
      concluded. This process involves releasing the Miro boards and custodians that were under legal hold, allowing the preserved
      boards to return to normal operations. Closing a legal hold will permanently delete it. For more information, see our
      <a href="https://help.miro.com/hc/en-us/articles/21922521629330-Close-a-legal-hold" target=_blank>Help Center page on
      closing a legal hold</a>.
  - info:
      name: Get content items under legal hold
      type: http
    http:
      method: GET
      url: https://api.miro.com/v2/orgs/:org_id/cases/:case_id/legal-holds/:legal_hold_id/content-items
      params:
      - name: org_id
        value: '3074457345618265000'
        type: path
        description: The ID of the organization for which you want to retrieve the list of content items under hold.
      - name: case_id
        value: '3074457345619012007'
        type: path
        description: The ID of the case for which you want to retrieve the list of content items under hold.
      - name: legal_hold_id
        value: '3074457345619013003'
        type: path
        description: The ID of the legal hold for which you want to retrieve the list of content items under hold.
      - name: limit
        value: '10'
        type: query
        description: The maximum number of items in the result list.
      - name: cursor
        value: MTY2OTg4NTIwMDAwMHwxMjM=
        type: query
        description: 'An indicator of the position of a page in the full set of results. To obtain the first page leave it
          empty. To obtain subsequent pages set it to the value returned in the cursor field of the previous request.

          '
    docs: Once a legal hold is in place you can review or explore the preserved Miro boards to ensure that all relevant data
      is intact and ready for legal proceedings or investigations. For more information, see our <a href="https://help.miro.com/hc/en-us/articles/22120628583570-Review-boards-under-legal-hold"
      target=_blank>Help Center page on reviewing boards under legal hold</a>. <br><br>This API lists all content items under
      a specific legal hold in a case for an organization. Please verify that the le
- info:
    name: Board Export
    type: folder
  items:
  - info:
      name: Get board export jobs list
      type: http
    http:
      method: GET
      url: https://api.miro.com/v2/orgs/:org_id/boards/export/jobs
      params:
      - name: org_id
        value: '3074457345821141000'
        type: path
        description: Unique identifier of the organization.
      - name: status
        value: ''
        type: query
        description: Status of the board export jobs that you want to retrieve, such as JOB_STATUS_CREATED, JOB_STATUS_IN_PROGRESS,
          JOB_STATUS_CANCELLED or J

# --- truncated at 32 KB (194 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/miro/refs/heads/main/apis.yml