Board

Contains information about the board, the team to which the board belongs, and the board's sharing policy and permissions policy.

Property nameProperty typeDescription
idStringUnique identifier of the board. You can obtain the board_id from the board URL. The board_id is the URL element after the /app/board/ subdirectory in the board URL. For example, in the board URL https://miro.com/app/board/o9J_l9_I58Q=/, the board_id is o9J_l9_I58Q=. You can use the board ID to retrieve board, board member, or board content information.
typeStringThe type of object that is returned. In this case, type returns board.
createdAtTimestampDate and time when the board was created. Format: UTC, adheres to ISO 8601, includes a trailing Z offset.
createdByuserContains information about the user who created the board.
currentUserMembershipboard memberContains information about the current user's board membership.
descriptionStringDescription of the board.
modifiedAtTimestampDate and time when the board was last modified. Format: UTC, adheres to ISO 8601, includes a trailing Z offset.
modifiedByuserContains information about the user who last modified the board.
nameStringName of the board.
owneruserContains information about the user who owns the board.
policyObjectContains information about the permissions policies and sharing policies for the board.
permissionsPolicypermissionsPolicyContains information about the permissions policies for the board.
sharingPolicysharingPolicyIndicates the public-level access and the team-level access for the board. The access level that a user gets depends on the highest level of access that results from considering the public-level access, team-level access, and direct sharing, which is represented by the Board member. For example, if you set sharingPolicy.access to private and sharingPolicy.teamAccess to view, only users who are members of the same team can access the board. If you set sharingPolicy.access to view and sharingPolicy.teamAccess to private, also users outside the team can access the board. If you set sharingPolicy.access to private and sharingPolicy.teamAccess to private, only the board owner can access to the board. If the board is shared with specific people, those people also have access to the board.
teamteamContains information about the team with which the board is associated.
viewLinkStringURL to view the board.
{
  "id": "uXjVOVq0ioE=",
  "type": "board",
  "createdAt": "2022-01-13T17:19:35Z",
  "createdBy": {
    "id": "3074457362577955221",
    "type": "user",
    "name": "John Smith"
  },
  "currentUserMembership": {
    "id": "3074457362577955221",
    "type": "board_member",
    "name": "John Smith",
    "role": "owner"
  },
  "description": "",
  "modifiedAt": "2022-03-08T12:06:43Z",
  "modifiedBy": {
    "id": "3074457362577955221",
    "type": "user",
    "name": "John Smith"
  },
  "name": "test board",
  "owner": {
    "id": "3074457362577955221",
    "type": "user",
    "name": "John Smith"
  },
  "permissionsPolicy": {
    "collaborationToolsStartAccess": "all_editors",
    "copyAccess": "team_editors",
    "copyAccessLevel": "team_editors",
    "sharingAccess": "team_members_with_editing_rights"
  },
  "policy": {
    "permissionsPolicy": {
      "collaborationToolsStartAccess": "all_editors",
      "copyAccess": "team_editors",
      "copyAccessLevel": "team_editors",
      "sharingAccess": "team_members_with_editing_rights"
    },
    "sharingPolicy": {
      "access": "private",
      "inviteToAccountAndBoardLinkAccess": "editor",
      "organizationAccess": "private",
      "teamAccess": "private"
    }
  },
  "sharingPolicy": {
    "access": "private",
    "inviteToAccountAndBoardLinkAccess": "editor",
    "organizationAccess": "private",
    "teamAccess": "private"
  },
  "team": {
    "id": "3074457362577833142",
    "type": "team",
    "name": "Doc sample team"
  },
  "viewLink": "https://miro.com/app/board/uXjVOVq0ioE="
}