DocuSign: Gets a single clickwrap object
DocuSign click.clickClickwrapsGetClickwrap: arguments, response, policy and SDK examples.
← Click operations · Get started
Operation docusign.click_clickwraps_getclickwrap
Provider route: GET /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}. 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["click"]["clickClickwrapsGetClickwrap"]>[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.click.clickClickwrapsGetClickwrap(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.click.click_clickwraps_get_clickwrap(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.clickwrapId | 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 Gets a single clickwrap object — response body |
Referenced models: Gets a single clickwrap object — response body
Schemas
Section titled “Schemas”Gets a single clickwrap object — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountId | string | Optional | A GUID that identifies your account. This value is automatically generated by DocuSign for any account you create. Copy the value from the **API Account ID** field in the **API and Keys** page in eSignature Settings. |
clickwrapId | string | Optional | The ID of the clickwrap. |
clickwrapName | string | Optional | The name of the clickwrap. |
clickwrapVersionId | string | Optional | The unique version ID, a GUID, of this clickwrap version. |
createdTime | object | Optional | The time that the clickwrap was created. |
displaySettings | Model | Optional | Expand Checks if a user has agreed to a clickwrap — response body — settings Display settings for a clickwrap. |
documents | array | Optional | An array of documents. |
documents[] | Model | Each item | Expand Gets a single clickwrap object — response body — documents item |
lastModified | object | Optional | The time that the clickwrap was last modified. |
lastModifiedBy | string | Optional | The user ID of the last user who modified this clickwrap. |
ownerUserId | string | Optional | The user ID of the owner of this clickwrap. |
requireReacceptance | boolean | Optional | When **true**, requires signers who have previously agreed to this clickwrap to sign again. The version number is incremented. |
scheduledDate | object | Optional | The time and date when this clickwrap is activated. |
scheduledReacceptance | Model | Optional | Expand Creates a new clickwrap version — response body — scheduled Reacceptance Specifies the interval between reacceptances in days, weeks, months, or years. |
status | string | Optional | Clickwrap status. Possible values: - `active` - `inactive` - `deleted` |
versionId | string | Optional | The ID of the version. |
versionNumber | string | Optional | Version of the clickwrap. |
Referenced models: Creates a new clickwrap version — response body — scheduled Reacceptance, Checks if a user has agreed to a clickwrap — response body — settings, Gets a single clickwrap object — response body — documents item
Creates a new clickwrap version — response body — scheduled Reacceptance
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
recurrenceInterval | JSON | Optional | |
recurrenceInterval (anyOf 1) | integer | Alternative | The time between recurrences specified in `recurrenceIntervalType` units. The minimum and maximum values depend on `recurrenceIntervalType`: - `days`: 1 - 365 - `weeks`: 1 - 52 - `months`: 1 - 12 - `years`: 1 Format: int32 |
recurrenceInterval (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
recurrenceIntervalType | string | Optional | The units of the `recurrenceInterval`. Must be one of: - `days` - `weeks` - `month` - `years` |
startDateTime | object | Optional | The date when the recurrence interval starts. |
Checks if a user has agreed to a clickwrap — response body — settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about how an agreement is displayed. |
actionButtonAlignment | string | Optional | Position of the Accept button in the agreement. One of - `right` - `left` |
allowClientOnly | boolean | Optional | When **true**, this agreement can be be used in client-only integrations |
allowedHosts | array | Optional | Hosts that can host the clickwrap. It is an error if the clickwrap didn't come from one of these hosts. |
allowedHosts[] | string | Each item | |
brandId | string | Optional | The signing brand ID. |
consentButtonText | string | Optional | Text on the agree button. |
consentText | string | Optional | The text on agree button. |
declineButtonText | string | Optional | The text on the decline button. |
displayName | string | Optional | The display name of the user agreement. |
documentDisplay | string | Optional | Display type: link or document |
downloadable | boolean | Optional | **True** if the agreement is downloadable. |
format | string | Optional | Display format: inline or modal. |
hasDeclineButton | boolean | Optional | **True** if the agreement has a decline checkbox. |
hostOrigin | string | Optional | The host origin. |
mustRead | boolean | Optional | **True** if the user needs to scroll to the end of the document. |
mustView | boolean | Optional | **True** if the user must view the document. |
recordDeclineResponses | boolean | Optional | When **true**, this agreement records decline actions. |
requireAccept | boolean | Optional | **True** if accept is required. |
sendToEmail | boolean | Optional | **True** if send to email is applicable. |
Gets a single clickwrap object — response body — documents item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a document. |
documentBase64 | string | Optional | The base64-encoded contents of the document. |
documentHtml | string | Optional | The HTML representation of the document. |
documentName | string | Optional | The name of the document. |
fileExtension | string | Optional | The file extension of the document. |
order | JSON | Optional | |
order (anyOf 1) | integer | Alternative | The order of document layout. Format: int32 |
order (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.click_clickwraps_getclickwrap. Catalog operation: click:Clickwraps_GetClickwrap. 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.