DocuSign: Reserved: Gets the shared item status for one or more users
DocuSign esignature.esignatureSharedAccessGetSharedAccess: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_sharedaccess_getsharedaccess
Provider route: GET /restapi/v2.1/accounts/{accountId}/shared_access. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureSharedAccessGetSharedAccess"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.esignature.esignatureSharedAccessGetSharedAccess(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_docusign import DocuSignIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.esignature.esignature_shared_access_get_shared_access(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.count | string | Optional | |
query.envelopes_not_shared_user_status | string | Optional | |
query.folder_ids | string | Optional | |
query.item_type | string | Optional | |
query.search_text | string | Optional | |
query.shared | string | Optional | |
query.start_position | string | Optional | |
query.user_ids | string | Optional |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Reserved: Gets the shared item status for one or more users — response body |
Referenced models: Reserved: Gets the shared item status for one or more users — response body
Schemas
Section titled “Schemas”4 more schemas are linked from the tables above, on the schema pages.
Reserved: Gets the shared item status for one or more users — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains shared access information. |
accountId | string | Optional | The account ID associated with the envelope. |
endPosition | string | Optional | The last index position in the result set. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details A complex type containing an errorCode and message identifying the error that occurred. |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
previousUri | string | Optional | The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. |
resultSetSize | string | Optional | The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. |
sharedAccess | array | Optional | A list of shared access information of envelope and templates for the users specified in the request. |
sharedAccess[] | Model | Each item | Expand Reserved: Gets the shared item status for one or more users — response body — shared Access item |
startPosition | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. |
Referenced models: Locks a template — response body — error Details, Reserved: Gets the shared item status for one or more users — response body — shared Access item
Locks a template — response body — error Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object describes errors that occur. It is only valid for responses and ignored in requests. |
errorCode | string | Optional | The code associated with the error condition. |
message | string | Optional | A brief message describing the error condition. |
Reserved: Gets the shared item status for one or more users — response body — shared Access item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about shared items. |
envelopes | array | Optional | List of information about shared envelopes. |
envelopes[] | Model | Each item | Expand Reserved: Gets the shared item status for one or more users — response body — shared Access item envelopes item |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
folders | array | Optional | List of information about shared folders. |
folders[] | Model | Each item | Expand Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item |
templates | array | Optional | List of information about shared templates. |
templates[] | Model | Each item | Expand Reserved: Gets the shared item status for one or more users — response body — shared Access item templates item |
user | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner Information about the user requesting sharing information. |
Referenced models: Locks a template — response body — error Details, Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item, Reserved: Gets the shared item status for one or more users — response body — shared Access item envelopes item, Reserved: Gets the shared item status for one or more users — response body — shared Access item templates item, Gets a specific template associated with a specified account — response body — owner
Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
folderId | string | Optional | The ID of the folder. |
name | string | Optional | The name of the folder. |
owner | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner Information about the user who owns the folder. |
parentFolderId | string | Optional | The ID of the parent folder. |
parentFolderUri | string | Optional | The URI for the parent folder. |
shared | string | Optional | Indicates how the folder is shared. Valid values are: - `not_shared` - `shared_to` |
sharedGroups | array | Optional | A list of groups that share the folder. |
sharedGroups[] | Model | Each item | Expand Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Groups item |
sharedUsers | array | Optional | A list of users that share the folder. |
sharedUsers[] | Model | Each item | Expand Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Users item |
uri | string | Optional | A URI containing the user ID. |
user | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner Information about the user associated with the folder. |
Referenced models: Locks a template — response body — error Details, Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Groups item, Gets a specific template associated with a specified account — response body — owner, Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Users item
Reserved: Gets the shared item status for one or more users — response body — shared Access item envelopes item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about the shared item. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
shared | string | Optional | How the item is shared. One of: - `not_shared` - `shared_to` - `shared_from` - `shared_to_and_from` |
user | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner Information about the user who owns the shared item. |
Referenced models: Locks a template — response body — error Details, Gets a specific template associated with a specified account — response body — owner
Gets a specific template associated with a specified account — response body — owner
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountId | string | Optional | The account ID associated with the envelope. |
accountName | string | Optional | The name on the account. |
activationAccessCode | string | Optional | Access code provided to the user to activate the account. |
email | string | Optional | The user's email address. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
ipAddress | string | Optional | |
loginStatus | string | Optional | When **true,** indicates that the user is logged in. This is a read-only property. |
membershipId | string | Optional | The user's membership ID. |
sendActivationEmail | string | Optional | This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/). |
uri | string | Optional | A URI containing the user ID. |
userId | string | Optional | The ID of the user to access. |
userName | string | Optional | The name of the user. |
userStatus | string | Optional | Status of the user's account. One of: - `ActivationRequired` - `ActivationSent` - `Active` - `Closed` - `Disabled` |
userType | string | Optional | The type of user, for example `CompanyUser`. |
Referenced models: Locks a template — response body — error Details
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_sharedaccess_getsharedaccess. Catalog operation: esignature:SharedAccess_GetSharedAccess. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.