Folder Share Recipients

Syntax

The following user permissions are needed to access this resource:

• View Dashboards in Public Folders (for dashboard folders)
• View Reports in Public Folders (for report folders)

URI

/services/data/v41.0/folders/<folderId>/share-recipients?shareType=<shareType>

Formats

JSON

HTTP methods

Method	Description
GET	Returns a list of share recipients with whom the folder can be shared.

Parameters

Parameter	Description	Default
folderId	Return data for this unique folder ID.
shareType	Return data for the recipients of the specified type, such as user, group, or role.	User
searchTerm	Search to match share recipients names.	“ ”
limit	Limit to the number of search results.	100

GET

Response Body

Property	Type	Description	Default
shareRecipients	List<FolderShareRecipientRepresentation>	List of recipients along with their share type.
shareType	ConnectFolderShareTypeEnum	Type of share. The following are the supported share types. Group. Users in a specified public group. Role. Users with a specified role. RoleAndSubordinates. Users with a specified role and users with a role subordinate to that role. RoleAndSubordinatesInternal. Users with a specified role and users with a role subordinate to that role, except public portal users. Organization. All internal users. AllPrmUsers. All PRM Portal users. User. The specified individual user. PartnerUser. The specified individual user of a partner portal. AllCspUsers. All Customer Success Portal users. CustomerPortalUser. The specified individual user of a customer portal. PortalRole. Users with a specified role in a portal. PortalRoleAndSubordinates. Portal users with a specified role, and portal users with a role subordinate to that role. ChannelProgramGroup. PRM Portal users who are members of the specified channel programs and levels group.
shareWithId	ID	Return the URL for share recipients.
shareWithLabel	String	Label of the folder share recipient.

Status Codes

Condition	Code	Payload
Success	200	FolderShareRecipientCollectionRepresentation
Missing perm	403	[ { "errorCode" : "FUNCTIONALITY_NOT_ENABLED", "message" : "<message>]"}]
No such folder, Unsupported folder type, Unauthorized (missing access on a specific folder)	404	[ { "errorCode" : "<errorCode>", "message" : "<message>" } ]

Output Example 1

Get share recipients of type user.

Output Example 2

Search for share recipients of type Public Group, with search term Group.