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, including creation, retrieval, updating, signing, and other document-related operations. Specifically for the Document - Get operation, it retrieves detailed information about a document using its unique token.
Common scenarios where this node is beneficial include:
- Fetching the current status or metadata of a specific document.
- Retrieving document details before performing further actions like sending for signing or cancellation.
- Integrating document data into automated workflows for audit, reporting, or compliance purposes.
Practical example:
- You have a document token from a previously created document and want to fetch its current status and details to decide if it should be sent for signing or archived.
Properties
| Name | Meaning |
|---|---|
| Document Token | The unique token identifier of the document to retrieve. This is required to specify which document's details to fetch. |
Output
The output is a JSON array containing one or more objects representing the document details returned by the ZapSign API. The structure typically includes fields such as document metadata, status, signer information, timestamps, and other relevant attributes describing the document state.
No binary data is output for the "Get" operation; all data is returned in JSON format.
Dependencies
- Requires an API key credential for authenticating with the ZapSign API.
- Uses environment variables to determine the API base URL:
ZAPSIGN_API_BASE_URL_SANDBOX(optional sandbox URL)ZAPSIGN_API_BASE_URL(production URL fallback)
- Relies on HTTP requests to the ZapSign REST API endpoints.
Troubleshooting
- Missing or invalid Document Token: The operation requires a valid document token. Ensure the token is correctly provided and corresponds to an existing document.
- API errors: If the API returns errors (e.g., 404 Not Found), verify that the document token exists and that your API credentials have access rights.
- Network issues: Connectivity problems may cause request failures. Check network access and proxy settings if applicable.
- Credential misconfiguration: Ensure the API key credential is properly configured in n8n and has permissions for document retrieval.
Links and References
- ZapSign API Documentation (official API docs for detailed endpoint info)
- ZapSign Developer Portal (for API keys and account setup)
This summary focuses exclusively on the Document - Get operation as requested, based on static analysis of the provided source code and property definitions.