Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.countstringOptional
query.envelopes_not_shared_user_statusstringOptional
query.folder_idsstringOptional
query.item_typestringOptional
query.search_textstringOptional
query.sharedstringOptional
query.start_positionstringOptional
query.user_idsstringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand 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

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
FieldTypePresenceDescription and constraints
$objectRootContains shared access information.
accountIdstringOptionalThe account ID associated with the envelope.
endPositionstringOptionalThe last index position in the result set.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
A complex type containing an errorCode and message identifying the error that occurred.
nextUristringOptionalThe 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.
previousUristringOptionalThe 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.
resultSetSizestringOptionalThe 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`.
sharedAccessarrayOptionalA list of shared access information of envelope and templates for the users specified in the request.
sharedAccess[]ModelEach itemExpand Reserved: Gets the shared item status for one or more users — response body — shared Access item
startPositionstringOptionalThe starting index position of the current result set.
totalSetSizestringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRootThis object describes errors that occur. It is only valid for responses and ignored in requests.
errorCodestringOptionalThe code associated with the error condition.
messagestringOptionalA brief message describing the error condition.
Reserved: Gets the shared item status for one or more users — response body — shared Access item
FieldTypePresenceDescription and constraints
$objectRootInformation about shared items.
envelopesarrayOptionalList of information about shared envelopes.
envelopes[]ModelEach itemExpand Reserved: Gets the shared item status for one or more users — response body — shared Access item envelopes item
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
foldersarrayOptionalList of information about shared folders.
folders[]ModelEach itemExpand Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item
templatesarrayOptionalList of information about shared templates.
templates[]ModelEach itemExpand Reserved: Gets the shared item status for one or more users — response body — shared Access item templates item
userModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
folderIdstringOptionalThe ID of the folder.
namestringOptionalThe name of the folder.
ownerModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
Information about the user who owns the folder.
parentFolderIdstringOptionalThe ID of the parent folder.
parentFolderUristringOptionalThe URI for the parent folder.
sharedstringOptionalIndicates how the folder is shared. Valid values are:

- `not_shared`
- `shared_to`
sharedGroupsarrayOptionalA list of groups that share the folder.
sharedGroups[]ModelEach itemExpand Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Groups item
sharedUsersarrayOptionalA list of users that share the folder.
sharedUsers[]ModelEach itemExpand Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Users item
uristringOptionalA URI containing the user ID.
userModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRootInformation about the shared item.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
sharedstringOptionalHow the item is shared. One of:

- `not_shared`
- `shared_to`
- `shared_from`
- `shared_to_and_from`
userModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
accountIdstringOptionalThe account ID associated with the envelope.
accountNamestringOptionalThe name on the account.
activationAccessCodestringOptionalAccess code provided to the user to activate the account.
emailstringOptionalThe user's email address.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
ipAddressstringOptional
loginStatusstringOptionalWhen **true,** indicates that the user is logged in. This is a read-only property.
membershipIdstringOptionalThe user's membership ID.
sendActivationEmailstringOptionalThis 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/).
uristringOptionalA URI containing the user ID.
userIdstringOptionalThe ID of the user to access.
userNamestringOptionalThe name of the user.
userStatusstringOptionalStatus of the user's account. One of:

- `ActivationRequired`
- `ActivationSent`
- `Active`
- `Closed`
- `Disabled`
userTypestringOptionalThe type of user, for example `CompanyUser`.

Referenced models: Locks a template — response body — error Details

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.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.