Skip to content

DocuSign: Gets the agreement responses for a clickwrap version

DocuSign click.clickUserAgreementsGetClickwrapVersionAgreements: arguments, response, policy and SDK examples.

← Click operations · Get started

Operation docusign.click_useragreements_getclickwrapversionagreements

Provider route: GET /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionId}/users. 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["click"]["clickUserAgreementsGetClickwrapVersionAgreements"]>[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.clickUserAgreementsGetClickwrapVersionAgreements(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.click.click_user_agreements_get_clickwrap_version_agreements(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
path.clickwrapIdstringRequired within parent
path.versionIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.client_user_idstringOptional
query.from_datestringOptional
query.page_numberstringOptional
query.statusstringOptional
query.to_datestringOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get user agreements — response body

Referenced models: Get user agreements — response body

Get user agreements — response body
FieldTypePresenceDescription and constraints
$objectRoot
beginCreatedOnobjectOptionalUser agreements from this datetime.
minimumPagesRemainingJSONOptional
minimumPagesRemaining (anyOf 1)integerAlternativeNumber of pages remaining in the response.
Format: int32
minimumPagesRemaining (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageJSONOptional
page (anyOf 1)integerAlternativeThe number of the current page.
Format: int32
page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageSizeJSONOptional
pageSize (anyOf 1)integerAlternativeThe number of items per page.
Format: int32
pageSize (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
userAgreementsarrayOptionalAn array of user agreements.
userAgreements[]ModelEach itemExpand Checks if a user has agreed to a clickwrap — response body

Referenced models: Checks if a user has agreed to a clickwrap — response body

Checks if a user has agreed to a clickwrap — response body
FieldTypePresenceDescription and constraints
$objectRoot
accountIdstringOptionalA 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.
agreedOnobjectOptionalDate that the client last completed the agreement.

This property is null if `agreementUrl` is not null and `status` is not `agreed`.
agreementIdstringOptionalThe agreement ID.
agreementUrlstringOptionalWhen not null, an agreement is required for user specified by `clientUserId`.

When missing the user specified by `clientUserId`
has already agreed and does not require a new acceptance.

Use this URL to render the agreement in a web page.

<!--
or redirected to when providing redirect_url as a query paramter.
-->
clickwrapIdstringOptionalThe ID of the clickwrap.
clientUserIdstringOptionalThe user ID of the client.
consumerDisclosureHtmlstringOptionalThe customer-branded HTML with the Electronic Record and Signature Disclosure information
createdOnobjectOptionalThe date when the clickwrap was created. May be null.
declinedOnobjectOptionalThe date when the user declined the most recent required agreement.

This property is valid only when `status` is `declined`. Otherwise it is null.
documentsarrayOptionalAn array of documents.
documents[]ModelEach itemExpand Gets a single clickwrap object — response body — documents item
metadatastringOptionalA customer-defined string you can use in requests. This string will appear in the corresponding response.
settingsModelOptionalExpand Checks if a user has agreed to a clickwrap — response body — settings
The display settings for this agreement.
statusstringOptionalUser agreement status. One of:

- `created`
- `agreed`
- `declined`
versionstringOptionalThe human-readable semver version string.
versionIdstringOptionalThe ID of the version.
versionNumberJSONOptional
versionNumber (anyOf 1)integerAlternativeVersion of the clickwrap.
Format: int32
versionNumber (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Checks if a user has agreed to a clickwrap — response body — settings, Gets a single clickwrap object — response body — documents item

Checks if a user has agreed to a clickwrap — response body — settings
FieldTypePresenceDescription and constraints
$objectRootInformation about how an agreement is displayed.
actionButtonAlignmentstringOptionalPosition of the Accept button in the agreement. One of

- `right`
- `left`
allowClientOnlybooleanOptionalWhen **true**, this agreement can be be used in client-only integrations
allowedHostsarrayOptionalHosts that can host the clickwrap.

It is an error if the clickwrap didn't come from one of these hosts.
allowedHosts[]stringEach item
brandIdstringOptionalThe signing brand ID.
consentButtonTextstringOptionalText on the agree button.
consentTextstringOptionalThe text on agree button.
declineButtonTextstringOptionalThe text on the decline button.
displayNamestringOptionalThe display name of the user agreement.
documentDisplaystringOptionalDisplay type: link or document
downloadablebooleanOptional**True** if the agreement is downloadable.
formatstringOptionalDisplay format: inline or modal.
hasDeclineButtonbooleanOptional**True** if the agreement has a decline checkbox.
hostOriginstringOptionalThe host origin.
mustReadbooleanOptional**True** if the user needs to scroll to the end of the document.
mustViewbooleanOptional**True** if the user must view the document.
recordDeclineResponsesbooleanOptionalWhen **true**, this agreement records decline actions.
requireAcceptbooleanOptional**True** if accept is required.
sendToEmailbooleanOptional**True** if send to email is applicable.
Gets a single clickwrap object — response body — documents item
FieldTypePresenceDescription and constraints
$objectRootInformation about a document.
documentBase64stringOptionalThe base64-encoded contents of the document.
documentHtmlstringOptionalThe HTML representation of the document.
documentNamestringOptionalThe name of the document.
fileExtensionstringOptionalThe file extension of the document.
orderJSONOptional
order (anyOf 1)integerAlternativeThe order of document layout.
Format: int32
order (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

SDK function policy ID: docusign.click_useragreements_getclickwrapversionagreements. Catalog operation: click:UserAgreements_GetClickwrapVersionAgreements. 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.