Accounts: listSharedAccess

Reserved: Retrieves shared item status for one or more users and types of items.

Users with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves and the returned information is limited to the retrieving the status of all members of the account that are sharing their folders to the user. This is equivalent to setting the shared=shared_from.

Request

HTTP request

GET /v2/accounts/{accountId}/shared_access

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID Guid.

Optional Query Parameters
countstring

Specifies maximum number of results included in the response. If no value is specified, this defaults to 1000.

envelopes_not_shared_user_statusstring

folder_idsstring

A comma separated list of folder ID GUIDs.

item_typestring

Reserved:

search_textstring

This can be used to filter user names in the response. The wild-card '*' (asterisk) can be used around the string.

sharedstring

Reserved:

start_positionstring

Reserved:

user_idsstring

Reserved:

Responses

CodeDescriptionReference
200

Successful response.

accountSharedAccess
400

Error encountered.

errorDetails

SDK Method

Accounts::listSharedAccess

Definitions

accountSharedAccess
errorDetails
group
memberGroupSharedItem
memberSharedItems
sharedItem
templateSharedItem
userInfo
userSharedItem

Examples

Generic JSON Response
Generic XML Response