Actions9
Overview
The DocuSeal - Template: Get List operation retrieves a list of document templates from the DocuSeal platform. This node is useful for automating workflows that require access to available templates, such as populating dropdowns, filtering templates by specific criteria, or integrating template management into broader document automation processes.
Common scenarios include:
- Displaying available templates for user selection in subsequent workflow steps.
- Filtering templates by folder, external ID, or search query.
- Retrieving all templates or limiting the number of results for performance or pagination purposes.
Practical example:
A company wants to automate sending contracts using DocuSeal. The workflow first fetches all templates in the "Contracts" folder, then allows the user to select one for creating a new submission.
Properties
| Display Name | Type | Description |
|---|---|---|
| Environment | options | Choose between production and test environment. |
| Return All | boolean | Whether to return all results or only up to a given limit. |
| Limit | number | Max number of results to return (only shown if "Return All" is false). Minimum value: 1. |
| Filters | collection | Additional filters to narrow down the template list. Includes: |
| External ID | string | Filter templates by external ID. |
| Folder | string | Filter templates by folder name. |
| Include Archived | boolean | Whether to include archived templates. |
| Search Query | string | Search templates by name. |
Output
The output is an array of objects, each representing a template. Each object typically contains fields such as:
{
"id": 123,
"name": "Template Name",
"folder": "Folder Name",
"archived": false,
"external_id": "ext-456",
// ...other template metadata fields
}
- The exact structure may vary depending on the DocuSeal API response, but you can expect standard template metadata fields.
Dependencies
- External Service: Requires access to the DocuSeal API.
- API Credentials: You must configure valid DocuSeal API credentials in n8n under the credential type
docusealApi. - Environment Selection: The "Environment" property lets you choose between production and test environments.
Troubleshooting
Common Issues:
- Invalid Credentials: If your API key is missing or incorrect, the node will fail with an authentication error. Ensure your credentials are set up correctly in n8n.
- No Results Returned: If filters are too restrictive, you may receive an empty array. Adjust filter values to broaden your search.
- Limit Not Respected: If "Return All" is true, the "Limit" property is ignored and all matching templates are returned.
- API Errors: Any errors from the DocuSeal API (e.g., network issues, server errors) will be reported in the node's output or as execution errors.
Error Messages:
"error": "Invalid API key"– Check your DocuSeal credentials."error": "Request failed with status code 404"– The endpoint may not exist or the resource was not found."error": "Network Error"– There may be connectivity issues between n8n and DocuSeal.