DocuSign: Gets all the versions of an elastic template
DocuSign click.clickSupplementalClickwrapVersionsGetClickwrapVersions: arguments, response, policy and SDK examples.
← Click operations · Get started
Operation docusign.click_supplemental_clickwrapversions_getclickwrapversions
Provider route: GET /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions. 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"]["clickSupplementalClickwrapVersionsGetClickwrapVersions"]>[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.clickSupplementalClickwrapVersionsGetClickwrapVersions(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_supplemental_clickwrap_versions_get_clickwrap_versions(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 all the versions of an elastic template — response body |
Referenced models: Gets all the versions of an elastic template — response body
Schemas
Section titled “Schemas”Gets all the versions of an elastic template — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The results are paginated. Use the following properties to navigate the pages. - `page`: The page number of the current results. - `pageSize`: The number of results in the current page. - `minimumPagesRemaining`: The number of pages that follow this one. |
accountId | string | Optional | The external account number (int) or account ID GUID. |
clickwrapId | string | Optional | The GUID of the elastic template. |
clickwrapName | string | Optional | The name of the elastic template. |
minimumPagesRemaining | JSON | Optional | |
minimumPagesRemaining (anyOf 1) | integer | Alternative | An array of clickwrap versions. Format: int32 |
minimumPagesRemaining (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
page | JSON | Optional | |
page (anyOf 1) | integer | Alternative | The number of the current page. Format: int32 |
page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
pageSize | JSON | Optional | |
pageSize (anyOf 1) | integer | Alternative | The number of items per page. Format: int32 |
pageSize (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
versions | array | Optional | An array of elastic template versions. |
versions[] | Model | Each item | Expand Gets all the versions of an elastic template — response body — versions item |
Referenced models: Gets all the versions of an elastic template — response body — versions item
Gets all the versions of an elastic template — response body — versions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
clickwrapVersionId | string | Optional | The unique GUID of this elastic template version. |
createdTime | object | Optional | The time that the elastic template was created. |
dataFields | array | Optional | An array of `dataField` objects. |
dataFields[] | Model | Each item | Expand Gets all the versions of an elastic template — response body — versions item data Fields item |
lastModified | object | Optional | The time that the elastic template was last modified. |
lastModifiedBy | string | Optional | The user GUID of the last user who modified this elastic template. |
ownerUserId | string | Optional | The user GUID of the owner of this clickwrap. |
requireReacceptance | boolean | Optional | When **true,** requires signers who have previously agreed to this elastic signing agreement to sign again. The major version number is incremented, and the minor version number is set to zero. For example: `2.1` to `3.0` When **false,** signers who have previously agreed do not need to sign again. Only the minor version number is incremented. For example: `2.1` to `2.2` |
scheduledDate | object | Optional | The time and date when this elastic template 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 GUID of the version. |
versionNumber | string | Optional | Human-readable version number. For example `1.2`. |
Referenced models: Creates a new clickwrap version — response body — scheduled Reacceptance, Gets all the versions of an elastic template — response body — versions item data Fields 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. |
Gets all the versions of an elastic template — response body — versions item data Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes a single data field. |
label | string | Optional | The label of the datafield. This is the text that is displayed to the user. |
name | string | Optional | A string used to refer to the field internally. The name must be unique within an elastic template. The following fields are predefined by the API: - `fullName` - `email` - `company` - `title` - `date` |
type | string | Optional | The type of the field. Valid values: - `STRING` - `NUMBER` - `DATE` |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.click_supplemental_clickwrapversions_getclickwrapversions. Catalog operation: click_supplemental:ClickwrapVersions_GetClickwrapVersions. 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.