__INITIALS__
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 retrieving the status of the members of the account that are sharing their folders to the user. This is equivalent to setting the shared
parameter to shared_from
.
GET /v2.1/accounts/{accountId}/shared_access
Parameter Name | Value | Description |
---|---|---|
Path Parameters | ||
accountId | string | The external account number (int) or account ID GUID. |
Optional Query Parameters | ||
count | string | Specifies the maximum number of results included in the response. If no value is specified, this defaults to 1000. |
envelopes_not_shared_user_status | string | This query parameter works in conjunction with
|
folder_ids | string | A comma-separated list of folder IDs for which to return shared item information. If |
item_type | string | Specifies the type of shared item being requested. The possible values are:
|
search_text | string | Filter user names based on the specified string. The wild-card '*' (asterisk) can be used in the string. |
shared | string | A comma-separated list of sharing filters that specifies which users appear in the response.
If the current user does not have administrative privileges, only the |
start_position | string | If the number of responses is greater than |
user_ids | string | A comma-separated list of user IDs for whom the shared item information is being requested. |
Code | Description | Reference |
---|---|---|
200 | Successful response. | accountSharedAccess |
400 | Error encountered. | errorDetails |