The Integration Guide covers the minimal flow: create, distribute, check status, and download. This resource documents the rest of the operations on an envelope — listing with filters, updating, cancelling, duplicating, resending, and fetching several at once.
List envelopes
Section titled “List envelopes”GET /envelopeReturns a paginated list. Accepts these query parameters:
| Parameter | Values | Description |
|---|---|---|
query |
text | Free-text search across title and other indexed fields. |
page / perPage |
number | Pagination (perPage defaults to 10). |
type |
DOCUMENT, TEMPLATE |
Filter by envelope type. |
templateId |
number | Only envelopes created from that template. |
source |
DOCUMENT, TEMPLATE, TEMPLATE_DIRECT_LINK |
Filter by creation source. |
status |
DRAFT, PENDING, COMPLETED, REJECTED, CANCELLED |
Filter by status. |
hasExpiredRecipients |
true, false |
Only envelopes with a recipient whose signing link expired. |
folderId |
string | Filter by folder. |
orderByColumn / orderByDirection |
createdAt / asc, desc |
List ordering. |
See the full spec in the API Reference.
Get multiple envelopes
Section titled “Get multiple envelopes”POST /envelope/get-manyTakes an ids array and returns each one’s detail in a single call — useful to avoid N calls to GET /envelope/{envelopeId} when you already have the IDs (for example, after creating several documents from a template).
See the full spec in the API Reference.
Update an envelope
Section titled “Update an envelope”POST /envelope/updateModifies data (envelope properties like title or externalId) and/or meta (subject, message, redirectUrl, etc.) on an existing envelope. Only takes effect while the envelope is in DRAFT — once distributed, these properties are fixed.
See the full spec in the API Reference.
Cancel an envelope
Section titled “Cancel an envelope”POST /envelope/cancelCancels an in-progress envelope (DRAFT or PENDING), with an optional reason. Unlike a rejection (initiated by a recipient), cancellation is initiated by the envelope’s owner.
See the full spec in the API Reference.
Delete an envelope
Section titled “Delete an envelope”POST /envelope/deleteDeletes an envelope. A COMPLETED envelope can’t be deleted — cancel it first if it hasn’t reached that status yet.
See the full spec in the API Reference.
Duplicate an envelope
Section titled “Duplicate an envelope”POST /envelope/duplicateCreates a copy of an existing envelope. The includeRecipients and includeFields flags control whether the copy also brings the original recipients and fields, or starts blank to configure from scratch.
See the full spec in the API Reference.
Resend to pending recipients
Section titled “Resend to pending recipients”POST /envelope/redistributeRe-notifies specific recipients of an already-distributed envelope — for example, if they missed the original email or their link expired. Takes recipients, the list of recipients to re-notify.
See the full spec in the API Reference.
See also
Section titled “See also”- Recipients — adding and managing who signs
- Fields — field types and their options
- Templates — creating reusable envelopes