docusign.accounts.get-shared-access

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. Note: This endpoint returns the shared status for the legacy Shared Envelopes feature. To use the new Shared Access feature, use the Authorizations resource. ### Related topics - How to share access to a Docusign envelope inbox

Reserved: Gets the shared item status for one or more users.

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
count	string	No	—	The maximum number of results to return. Use start_position to specify the number of results to skip. Default: 1000
envelopes_not_shared_user_status	string	No	—	This query parameter works in conjunction with user_ids. When you specify one of the following user statuses, the query limits the results to only users that match the specified status: - ActivationRequired: Membership Activation required - ActivationSent: Membership activation sent to user - Active: User Membership is active - Closed: User Membership is closed - Disabled: User Membership is disabled
folder_ids	string	No	—	A comma-separated list of folder IDs for which to return shared item information. If item_type is set to folders, at least one folder ID is required.
item_type	string	No	—	Specifies the type of shared item being requested. Valid values: - envelopes: Get information about envelope sharing between users. - templates: Get information about template sharing among users and groups. - folders: Get information about folder sharing among users and groups.
search_text	string	No	—	Filter user names based on the specified string. The wild-card '*' (asterisk) can be used in the string.
shared	string	No	—	A comma-separated list of sharing filters that specifies which users appear in the response. - not_shared: The response lists users who do not share items of item_type with the current user. - shared_to: The response lists users in user_list who are sharing items to current user. - shared_from: The response lists users in user_list who are sharing items from the current user. - shared_to_and_from: The response lists users in user_list who are sharing items to and from the current user. If the current user does not have administrative privileges, only the shared_to option is valid.
start_position	string	No	—	The zero-based index of the result from which to start returning results. Use with count to limit the number of results. The default value is 0.
user_ids	string	No	—	A comma-separated list of user IDs for whom the shared item information is being requested.

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
count	string	No	—	The maximum number of results to return. Use start_position to specify the number of results to skip. Default: 1000
envelopes_not_shared_user_status	string	No	—	This query parameter works in conjunction with user_ids. When you specify one of the following user statuses, the query limits the results to only users that match the specified status: - ActivationRequired: Membership Activation required - ActivationSent: Membership activation sent to user - Active: User Membership is active - Closed: User Membership is closed - Disabled: User Membership is disabled
folder_ids	string	No	—	A comma-separated list of folder IDs for which to return shared item information. If item_type is set to folders, at least one folder ID is required.
item_type	string	No	—	Specifies the type of shared item being requested. Valid values: - envelopes: Get information about envelope sharing between users. - templates: Get information about template sharing among users and groups. - folders: Get information about folder sharing among users and groups.
search_text	string	No	—	Filter user names based on the specified string. The wild-card '*' (asterisk) can be used in the string.
shared	string	No	—	A comma-separated list of sharing filters that specifies which users appear in the response. - not_shared: The response lists users who do not share items of item_type with the current user. - shared_to: The response lists users in user_list who are sharing items to current user. - shared_from: The response lists users in user_list who are sharing items from the current user. - shared_to_and_from: The response lists users in user_list who are sharing items to and from the current user. If the current user does not have administrative privileges, only the shared_to option is valid.
start_position	string	No	—	The zero-based index of the result from which to start returning results. Use with count to limit the number of results. The default value is 0.
user_ids	string	No	—	A comma-separated list of user IDs for whom the shared item information is being requested.
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call GET /v2.1/accounts/{accountId}/shared_access
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform GET /v2.1/accounts/{accountId}/shared_access
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.accounts.get-shared-access",
  "initial_data": {
    "base_url": "value",
    "accountid": "value"
  }
}