Actions33
- Template Actions
- Document Actions
- Signer Actions
- Background Check Actions
- Partnership Actions
- Timestamp Actions
- Webhook Actions
Overview
This node integrates with the ZapSign API to manage electronic document workflows, focusing on digital signatures and document lifecycle management. The Document - Get Many operation retrieves multiple documents from the user's ZapSign account with various filtering and sorting options.
Typical use cases include:
- Listing documents stored in specific folders.
- Filtering documents by their deletion status or signing status.
- Retrieving documents created within a certain date range.
- Sorting documents by creation date ascending or descending.
For example, a user might want to fetch all signed documents in a particular folder created in the last month, or list all deleted documents for audit purposes.
Properties
| Name | Meaning |
|---|---|
| Page | Page number of results to retrieve (starts at 1). Each page contains 25 documents by default. |
| Folder Path | Filter documents by folder path (e.g., "/api/pasta2/" or "/" for root folder). |
| Deleted Status | Filter by deletion status: - All Documents (both deleted and non-deleted) - Not Deleted only - Deleted Only |
| Document Status | Filter by document status: - All Statuses - Pending (in progress) - Signed (completed) - Refused (rejected) |
| Created From Date | Filter documents created from this date (format YYYY-MM-DD). |
| Created To Date | Filter documents created up to this date (format YYYY-MM-DD). |
| Sort Order | Sort order for the results: - Default (newest first) - Ascending (oldest first) - Descending (newest first) |
Output
The output is a JSON array containing the retrieved documents matching the specified filters and pagination. The structure corresponds to the API response from ZapSign's /api/v1/docs/ endpoint and typically includes:
- Metadata about pagination (e.g., total count, next page).
- An array of document objects with details such as document token, name, status, creation date, folder path, and other relevant attributes.
No binary data is returned in this operation.
Dependencies
- Requires an API key credential for authenticating with the ZapSign API.
- Uses environment variables to determine the base URL for the API:
ZAPSIGN_API_BASE_URL_SANDBOXfor sandbox environment (optional).ZAPSIGN_API_BASE_URLfor production environment (default fallback).
- The node uses internal helper functions to perform HTTP requests and handle responses.
Troubleshooting
- Empty or missing results: Ensure that the filter parameters are correct and that the page number is valid. If no documents match the criteria, the result will be empty.
- Authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
- Invalid date formats: The
createdFromandcreatedToproperties must be inYYYY-MM-DDformat; otherwise, the API may reject the request. - API rate limits or connectivity issues: Network problems or API limits can cause failures; check logs and retry if necessary.
Common error messages are generally related to invalid parameters or authentication failures and will be surfaced by the node accordingly.
Links and References
- ZapSign API Documentation (official API docs)
- ZapSign Node GitHub Repository (if available)
- n8n documentation on Creating Custom Nodes
If you need summaries for other resources or operations, please provide their names.