Sharing policy

Contains information about 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 Team User Connection Object.

sharingPolicy.teamAccess values:
private — nobody in the team can find and access the board
view — any team member can find and view the board
comment — any team member can find and comment on the board
edit — any team member can find and edit the board

sharingPolicy.access values:
private — only you have access to the board
view — can view, no sign-in required
comment — can comment, no sign-in required

For example, if you set sharingPolicy.access to private and sharingPolicy.teamAccess to view, users will have access to the board only if they are in the same team.

If you set sharingPolicy.access to view and sharingPolicy.teamAccess to private, users will have access to the board even if those users are not a part of the team.

If you set sharingPolicy.access to private and sharingPolicy.teamAccess to private, only the board owner has access to the board. If the board is shared with specific people, those people will also have access to the board.

Property nameProperty typeDescription
accessStringIndicates the public-level access to the board. Possible values: private—the board is not available publicly. However, if sharingPolicy.access is set to private and sharingPolicy.teamAccess is set to view, comment, or edit, the board is available to the user if the user is a member of the team view—anyone with the board URL can view the board. No sign-in required. comment—anyone with the board URL can view and add comments on the board. No sign-in required. Default: private
teamAccessStringIndicates the team-level access to the board. Possible values: private—the board is not available for the team. However, if sharingPolicy.teamAccess is set to private, but sharingPolicy.access is set to view or comment, the board is still available to the user as it is made available on public level. view—any team member can find and view the board. comment—any team member can find and comment on the board. edit—any team member can find and edit the board. Default: private
"sharingPolicy": {
        "access": "comment",
        "teamAccess": "comment"
    }

Returns

Returns a Board Object if the board exists and is available to the user.

Required scope

boards:write

Rate limiting

Level 2

Language
Authentication
OAuth2
Click Try It! to start a request and see the response here!