2025-09-25

We've added a new security feature to enhance board privacy and access control through the Miro Platform API. The accessPasswordRequired field is now available as a read-only field in the Get boards API endpoint which returns the current password requirement status when retrieving board information.

Field details:

• Type: boolean
• Default value: false
• Location: policy.sharingPolicy.accessPasswordRequired

📘

Note

This field is not available in POST or PATCH operations. Password protection settings must be configured through the Miro web interface.

Example response

Retrieving board information with password protection status:

{
  "id": "uXjVO055jdcvP4D5jf2ibN0efUh=",
  "name": "Confidential Project Board",
  "policy": {
    "sharingPolicy": {
      "access": "view",
      "accessPasswordRequired": true,
      "inviteToAccountAndBoardLinkAccess": "no_access"
    }
  }
}

Benefits

• Programmatic visibility: Determine if a board requires password access when integrating with Miro.
• Enhanced security awareness: Applications can now detect password-protected boards.
• Backward compatibility: Defaults to false to maintain existing behavior.

Migration notes

This is a non-breaking change. Existing applications will continue to work without modifications, and the field will default to false for all existing boards.

For applications that want to leverage this new security feature, include the accessPasswordRequired field in your board policy configurations.