SharedAccessEnvelopes
Retrieves the list of information about the shared envelopes.
The provider will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the provider.
- UserUserId supports the '=' and 'IN' operators.
- UserUserStatus supports the '=' operator.
- SearchText supports the '=' operator.
- Shared supports the '=' operator.
For example, the following queries are processed server side:
SELECT * FROM SharedAccessEncelopes
Columns
| Name | Type | References | Description |
| UserUserId [KEY] | String | The ID of the perspective user who owns the shared item. | |
| UserAccountId | String | The account ID of the perspective user. | |
| UserAccountName | String | The account name of the perspective user. | |
| UserActivationAccessCode | String | Access code provided to the perspective user to activate the account. | |
| UserEmail | String | The email address of the perspective user. | |
| UserIpAddress | String | The IP address of the perspective user. | |
| UserLoginStatus | String | When true, indicates that the perspective user is logged in. | |
| UserMembershipId | String | The membership ID of the perspective user. | |
| UserUri | String | A URI containing the perspective user ID. | |
| UserUserName | String | The name of the perspective user. | |
| UserUserStatus | String | Status of the perspective user's account. | |
| UserUserType | String | The type of the perspective user. | |
| Shared | String | How the item is shared. One of: not_shared, shared_to, shared_from, shared_to_and_from. | |
| EnvelopeUserUserId | String | The ID of the user in the shared envelope. | |
| EnvelopeUserAccountId | String | The account ID of the user in the shared envelope. | |
| EnvelopeUserAccountName | String | The account name of the user in the shared envelope. | |
| EnvelopeUserActivationAccessCode | String | Access code provided to the user in the shared envelope to activate the account. | |
| EnvelopeUserEmail | String | The email address of the user in the shared envelope. | |
| EnvelopeUserIpAddress | String | The IP address of the user in the shared envelope. | |
| EnvelopeUserLoginStatus | String | When true, indicates that the user in the shared envelope is logged in. | |
| EnvelopeUserMembershipId | String | The membership ID of the user in the shared envelope. | |
| EnvelopeUserUri | String | A URI containing the user ID of the user in the shared envelope. | |
| EnvelopeUserUserName | String | The name of the user in the shared envelope. | |
| EnvelopeUserUserStatus | String | Status of the user account in the shared envelope. One of: ActivationRequired, ActivationSent, Active, Closed, Disabled. | |
| EnvelopeUserUserType | String | The type of the user in the shared envelope. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| SearchText | String | Filter user names based on the specified string. The wild-card '*' (asterisk) can be used in the string. |