Agreement → Get Many
AI-generatedSummary
Lists the user agreements recorded for a given DocuSign Click clickwrap by calling GET /clickwraps/{clickwrapId}/agreements on the Click API.
Inputs
- Clickwrap ID (required) — ID of the clickwrap whose agreements are listed. Inserted into the request path.
- Return All — When true, no count is sent and the API's default response is returned. Default false.
- Limit — Shown only when Return All is false. Sent as the
countquery parameter. Range 1–100, default 50.
Output shape
Items built from the API response for each input item. The response goes through n8n's returnJsonArray, so an array becomes multiple items and a single object becomes one item. The Click API typically wraps results in an object (e.g. a userAgreements list), so expect one item containing that list.
No pagination loop is implemented. Return All only omits the count parameter, so it may not fetch every record beyond the API's default page size. Requests run per input item. Non-429 4xx errors fail immediately. Other errors, including 429, are retried up to 3 times with exponential backoff. With Continue On Fail enabled, errors are returned as {error: message} items. The base URL depends on the credential's environment (demo or production), region (default na1) and account ID.
Examples
Example 1: Fetch the 20 most recent agreements for a clickwrap
Resource: Agreement, Operation: Get Many, Clickwrap ID: your clickwrap ID, Return All: off, Limit: 20
Example 2: Look up agreements for clickwrap IDs coming from a previous node
Clickwrap ID set to an expression like {{$json.clickwrapId}}, Return All: on