DocuSign: Get user agreements
DocuSign click.clickUserAgreementsGetClickwrapAgreements: arguments, response, policy and SDK examples.
← Click operations · Get started
Operation docusign.click_useragreements_getclickwrapagreements
Provider route: GET /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/users. 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"]["clickUserAgreementsGetClickwrapAgreements"]>[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.clickUserAgreementsGetClickwrapAgreements(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_user_agreements_get_clickwrap_agreements(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 | |
query | object | Optional | Additional keys: not allowed |
query.client_user_id | string | Optional | |
query.from_date | string | Optional | |
query.page_number | string | Optional | |
query.status | string | Optional | |
query.to_date | string | Optional |
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 Get user agreements — response body |
Referenced models: Get user agreements — response body
Schemas
Section titled “Schemas”Get user agreements — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
beginCreatedOn | object | Optional | User agreements from this datetime. |
minimumPagesRemaining | JSON | Optional | |
minimumPagesRemaining (anyOf 1) | integer | Alternative | Number of pages remaining in the response. 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]+)?$ |
userAgreements | array | Optional | An array of user agreements. |
userAgreements[] | Model | Each item | Expand 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
| 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. |
agreedOn | object | Optional | Date that the client last completed the agreement. This property is null if `agreementUrl` is not null and `status` is not `agreed`. |
agreementId | string | Optional | The agreement ID. |
agreementUrl | string | Optional | When 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. --> |
clickwrapId | string | Optional | The ID of the clickwrap. |
clientUserId | string | Optional | The user ID of the client. |
consumerDisclosureHtml | string | Optional | The customer-branded HTML with the Electronic Record and Signature Disclosure information |
createdOn | object | Optional | The date when the clickwrap was created. May be null. |
declinedOn | object | Optional | The date when the user declined the most recent required agreement. This property is valid only when `status` is `declined`. Otherwise it is null. |
documents | array | Optional | An array of documents. |
documents[] | Model | Each item | Expand Gets a single clickwrap object — response body — documents item |
metadata | string | Optional | A customer-defined string you can use in requests. This string will appear in the corresponding response. |
settings | Model | Optional | Expand Checks if a user has agreed to a clickwrap — response body — settings The display settings for this agreement. |
status | string | Optional | User agreement status. One of: - `created` - `agreed` - `declined` |
version | string | Optional | The human-readable semver version string. |
versionId | string | Optional | The ID of the version. |
versionNumber | JSON | Optional | |
versionNumber (anyOf 1) | integer | Alternative | Version of the clickwrap. Format: int32 |
versionNumber (anyOf 2) | string | Alternative | Pattern: ^-?[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
| 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_useragreements_getclickwrapagreements. Catalog operation: click:UserAgreements_GetClickwrapAgreements. 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.