Actions33
- Template Actions
- Document Actions
- Signer Actions
- Background Check Actions
- Partnership Actions
- Timestamp Actions
- Webhook Actions
Overview
The node integrates with the ZapSign API to manage electronic document workflows, including templates, documents, signers, background checks, partnerships, timestamps, and webhooks. Specifically for the Template resource and the Get Template operation, the node retrieves detailed information about a specific template identified by its token.
This operation is useful when you want to fetch metadata and configuration details of an existing template in your ZapSign account. For example, you might use this to verify template properties before creating documents from it or to display template info in your automation flows.
Practical scenarios include:
- Retrieving a template's structure and metadata for validation.
- Fetching template details to dynamically generate documents.
- Auditing or logging template configurations within workflows.
Properties
| Name | Meaning |
|---|---|
| Template Token | The unique identifier (token) of the template to retrieve. This is a required, password-type string. |
Output
The output JSON contains the detailed data of the requested template as returned by the ZapSign API. This typically includes fields such as the template's name, creation date, variables, form inputs, and other metadata associated with the template.
No binary data is output for this operation; all data is returned as structured JSON.
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_SANDBOXfor sandbox orZAPSIGN_API_BASE_URLfor production). - Relies on internal helper functions for making HTTP requests and processing responses.
Troubleshooting
- Missing or invalid Template Token: The operation requires a valid template token. If the token is missing or malformed, the request will fail. Ensure the token matches the expected UUID format.
- API errors: If the API returns errors (e.g., 404 Not Found), it may indicate that the template does not exist or the token is incorrect.
- Permission issues: Ensure the API key used has sufficient permissions to access template data.
- Network issues: Verify connectivity to the ZapSign API endpoints and correct environment variable settings for the base URL.
Common error messages:
- "Template token is required for template document creation" — means the token was not provided.
- "Bad request - please check your parameters" — indicates invalid input parameters.
- 404 Not Found — template not found or inaccessible.
Links and References
- ZapSign API Documentation (general reference for API endpoints and usage)
- ZapSign Templates API (specific documentation for template operations)
This summary focuses exclusively on the Template resource and the Get Template operation as requested.