DocuSign: Returns document visibility for a template recipient
DocuSign esignature.esignatureRecipientsGetTemplateRecipientDocumentVisibility: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_recipients_gettemplaterecipientdocumentvisibility
Provider route: GET /restapi/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility. 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"]["esignatureRecipientsGetTemplateRecipientDocumentVisibility"]>[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.esignatureRecipientsGetTemplateRecipientDocumentVisibility(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_recipients_get_template_recipient_document_visibility(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 | |
path.recipientId | string | Required within parent | |
path.templateId | string | Required within parent |
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 Updates document visibility for recipients — response body |
Referenced models: Updates document visibility for recipients — response body
Schemas
Section titled “Schemas”Updates document visibility for recipients — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of `documentVisibility` objects that specify whether documents are visible to recipients. |
documentVisibility | array | Optional | An array of `documentVisibility` objects that specifies which documents are visible to which recipients. |
documentVisibility[] | Model | Each item | Expand Updates document visibility for recipients — response body — document Visibility item |
Referenced models: Updates document visibility for recipients — response body — document Visibility item
Updates document visibility for recipients — response body — document Visibility item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object configures a recipient's read/write access to a document. |
documentId | string | Optional | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. |
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. |
recipientId | string | Optional | The ID of the recipient to whom the document visibility setting is applied. This value should match the `recipientId` defined in the recipient object. |
rights | string | Optional | Indicates whether the document is editable: - `editable` - `read_only` |
visible | string | Optional | When **true,** the document is visible to the recipient. |
Referenced models: Locks a template — response body — error Details
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. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_recipients_gettemplaterecipientdocumentvisibility. Catalog operation: esignature:Recipients_GetTemplateRecipientDocumentVisibility. 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.