Legal holds

📘

Available only for Enterprise Guard

Cases and Legal Hold APIs are available only to customers on the Enterprise plan that have Enterprise Guard add-on enabled.

The Legal Hold feature is designed to support compliance and eDiscovery processes by preserving boards that are subject to investigation or relevant to ongoing legal cases. eDiscovery Admins can prevent the permanent deletion of content by creating legal holds based on specific users and their actions in Miro. This functionality is essential for ensuring that relevant information is retained and secure during legal proceedings. For example, when a user who is subject to a legal hold interacts with a board, that board is automatically placed on hold to prevent permanent deletion. Additionally, all versions of the board are also preserved ensuring that the board's content is retained for legal purposes.

📘

Due to the asynchronous nature of legal holds, after a legal hold is created, it might take up to 24 hours for the system to process all affected boards. The Get legal hold information API includes an endpoint to retrieve the state of a specific legal hold. When the legal hold has been completely processed, it is marked as ACTIVE, and you can then retrieve the list of content items under hold.

Process

The management of legal holds requires interacting with 2 main objects: cases and legal holds.

Cases: Creating a case is the first step in the eDiscovery process when litigation or an investigation is anticipated. By creating a case, you establish the formal structure needed to ensure that all relevant Miro boards are properly preserved for the duration of the legal matter. 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. This can be especially useful in scenarios where different legal holds are part of the same investigation, such as in a court case.

Legal holds: 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. Once a legal hold is in place, you can use the APIs to retrieve information about all legal holds in an organization, and to identify boards that are under hold .

📘

The current release of the legal hold APIs supports only read operations. To create or close cases and legal holds, you can use the Miro Admin console. For more information, see our Legal Hold Help Center article.

Workflow

1. Create an application with the organization:cases:management scope.
2. Install the application on any team in the organization.

   📘

   The installer must have both the Company Admin and eDiscovery Admin roles in this organization.

3. Use the access_token you received from the installation to manage cases and legal holds.

Example use case

1. Create a case.
2. Add a legal hold to a case.
3. Make a request to get legal hold information .
   1. Check the state of the legal hold. If it is PROCESSING, then allow some time for the system to finish processing and retry the request. If it is ACTIVE, then you can retrieve the list of content items affected by the legal hold.
4. Make a request to get the list of content items under hold .

   📘

   • This is a paginated list so multiple requests might be necessary to retrieve the full list.
   • When a content item is of the type board, then the contentId represents a boardKey which can be used to create a Board Export job.