Docusign eSignature API
Docusign Developer CenterGet a developer account
HomeAPI ReferenceSDKsContext Plugin
Accounts

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

GET
/v2.1/accounts/{accountId}/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

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

Query Parameters

count?string

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

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

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

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

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.

  • 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

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

A comma-separated list of user IDs for whom the shared item information is being requested.

Response Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/shared_access"
{  "accountId": "string",  "endPosition": "string",  "errorDetails": {    "errorCode": "string",    "message": "string"  },  "nextUri": "string",  "previousUri": "string",  "resultSetSize": "string",  "sharedAccess": [    {      "envelopes": [        {          "errorDetails": {            "errorCode": "string",            "message": "string"          },          "shared": "string",          "user": {            "accountId": "string",            "accountName": "string",            "activationAccessCode": "string",            "email": "string",            "errorDetails": {              "errorCode": "string",              "message": "string"            },            "ipAddress": "string",            "loginStatus": "string",            "membershipId": "string",            "sendActivationEmail": "string",            "uri": "string",            "userId": "string",            "userName": "string",            "userStatus": "string",            "userType": "string"          }        }      ],      "errorDetails": {        "errorCode": "string",        "message": "string"      },      "folders": [        {          "errorDetails": {            "errorCode": "string",            "message": "string"          },          "folderId": "string",          "name": "string",          "owner": {            "accountId": "string",            "accountName": "string",            "activationAccessCode": "string",            "email": "string",            "errorDetails": {              "errorCode": "string",              "message": "string"            },            "ipAddress": "string",            "loginStatus": "string",            "membershipId": "string",            "sendActivationEmail": "string",            "uri": "string",            "userId": "string",            "userName": "string",            "userStatus": "string",            "userType": "string"          },          "parentFolderId": "string",          "parentFolderUri": "string",          "shared": "string",          "sharedGroups": [            {              "errorDetails": {                "errorCode": "string",                "message": "string"              },              "group": {                "accessType": "string",                "dsGroupId": "string",                "errorDetails": {                  "errorCode": "string",                  "message": "string"                },                "groupId": "string",                "groupName": "string",                "groupType": "string",                "isManagedByScim": true,                "lastModifiedOn": "string",                "permissionProfileId": "string",                "userGroupType": "string",                "users": [                  {                    "accountId": "string",                    "accountName": "string",                    "activationAccessCode": "string",                    "email": "string",                    "errorDetails": {                      "errorCode": "string",                      "message": "string"                    },                    "ipAddress": "string",                    "loginStatus": "string",                    "membershipId": "string",                    "sendActivationEmail": "string",                    "uri": "string",                    "userId": "string",                    "userName": "string",                    "userStatus": "string",                    "userType": "string"                  }                ],                "usersCount": "string"              },              "shared": "string"            }          ],          "sharedUsers": [            {              "errorDetails": {                "errorCode": "string",                "message": "string"              },              "shared": "string",              "user": {                "accountId": "string",                "accountName": "string",                "activationAccessCode": "string",                "email": "string",                "errorDetails": {                  "errorCode": "string",                  "message": "string"                },                "ipAddress": "string",                "loginStatus": "string",                "membershipId": "string",                "sendActivationEmail": "string",                "uri": "string",                "userId": "string",                "userName": "string",                "userStatus": "string",                "userType": "string"              }            }          ],          "uri": "string",          "user": {            "accountId": "string",            "accountName": "string",            "activationAccessCode": "string",            "email": "string",            "errorDetails": {              "errorCode": "string",              "message": "string"            },            "ipAddress": "string",            "loginStatus": "string",            "membershipId": "string",            "sendActivationEmail": "string",            "uri": "string",            "userId": "string",            "userName": "string",            "userStatus": "string",            "userType": "string"          }        }      ],      "templates": [        {          "errorDetails": {            "errorCode": "string",            "message": "string"          },          "owner": {            "accountId": "string",            "accountName": "string",            "activationAccessCode": "string",            "email": "string",            "errorDetails": {              "errorCode": "string",              "message": "string"            },            "ipAddress": "string",            "loginStatus": "string",            "membershipId": "string",            "sendActivationEmail": "string",            "uri": "string",            "userId": "string",            "userName": "string",            "userStatus": "string",            "userType": "string"          },          "password": "string",          "shared": "string",          "sharedGroups": [            {              "errorDetails": {                "errorCode": "string",                "message": "string"              },              "group": {                "accessType": "string",                "dsGroupId": "string",                "errorDetails": {                  "errorCode": "string",                  "message": "string"                },                "groupId": "string",                "groupName": "string",                "groupType": "string",                "isManagedByScim": true,                "lastModifiedOn": "string",                "permissionProfileId": "string",                "userGroupType": "string",                "users": [                  {                    "accountId": "string",                    "accountName": "string",                    "activationAccessCode": "string",                    "email": "string",                    "errorDetails": {                      "errorCode": "string",                      "message": "string"                    },                    "ipAddress": "string",                    "loginStatus": "string",                    "membershipId": "string",                    "sendActivationEmail": "string",                    "uri": "string",                    "userId": "string",                    "userName": "string",                    "userStatus": "string",                    "userType": "string"                  }                ],                "usersCount": "string"              },              "shared": "string"            }          ],          "sharedUsers": [            {              "errorDetails": {                "errorCode": "string",                "message": "string"              },              "shared": "string",              "user": {                "accountId": "string",                "accountName": "string",                "activationAccessCode": "string",                "email": "string",                "errorDetails": {                  "errorCode": "string",                  "message": "string"                },                "ipAddress": "string",                "loginStatus": "string",                "membershipId": "string",                "sendActivationEmail": "string",                "uri": "string",                "userId": "string",                "userName": "string",                "userStatus": "string",                "userType": "string"              }            }          ],          "templateId": "string",          "templateName": "string"        }      ],      "user": {        "accountId": "string",        "accountName": "string",        "activationAccessCode": "string",        "email": "string",        "errorDetails": {          "errorCode": "string",          "message": "string"        },        "ipAddress": "string",        "loginStatus": "string",        "membershipId": "string",        "sendActivationEmail": "string",        "uri": "string",        "userId": "string",        "userName": "string",        "userStatus": "string",        "userType": "string"      }    }  ],  "startPosition": "string",  "totalSetSize": "string"}

Updates envelope notification default settings PUT

This method changes the default settings for the email notifications that signers and senders receive about envelopes.

Reserved: Sets the shared access information for users PUT

This sets the shared access status for one or more users or templates. When setting user shared access, only users with account administration privileges can set shared access status for envelopes. When setting template shared access, only users who own a template and have sharing permission or with account administration privileges can set shared access for templates. Changes to the shared items status are not additive. The change always replaces the current status. To change template shared access, add the query parameter `item_type` = `templates` to the request. When this is set, the user and envelopes properties are not required. **Note:** This functionality is a newer version of the [Update Group Share](https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/updategroupshare/) functionality. ### Related topics - [How to share access to a Docusign envelope inbox](https://developers.docusign.com/docs/esign-rest-api/how-to/shared-access/)