DocuSeal icon

DocuSeal

Create documents, manage templates, and handle submissions with DocuSeal

Actions23

Overview

The node interacts with the DocuSeal API to manage document submissions. Specifically, the "Submission" resource with the "Get Many" operation retrieves multiple submission records from DocuSeal based on various filters and limits.

This node is useful when you want to fetch a list of document submissions for reporting, monitoring, or further processing in your workflow. For example, you might use it to get all completed submissions within a certain range or to search submissions by submitter details.

Properties

Name Meaning
Limit Maximum number of submission results to return (minimum 1).
Filters Collection of filters to narrow down the submissions retrieved:
- After ID Fetch submissions with an ID greater than this value (cursor-based pagination).
- Archived Whether to include archived submissions (true/false).
- Before ID Fetch submissions with an ID less than this value (cursor-based pagination).
- Search Query Search submitters by name, email, or phone using a text query string.
- Status Filter submissions by status; can select multiple from: Completed, Declined, Expired, Pending.
- Template Name or ID Choose a specific template by name or ID to filter submissions related to that template.

Output

  • The output JSON array contains the list of submission objects returned by the DocuSeal API.
  • Each item corresponds to a submission record matching the specified filters and limit.
  • The structure of each submission object depends on the DocuSeal API response but typically includes submission metadata such as ID, status, submitter info, timestamps, and related template data.
  • This node does not output binary data for this operation.

Dependencies

  • Requires an active connection to the DocuSeal API via an API key credential configured in n8n.
  • The node uses the DocuSeal REST API endpoint /submissions with GET method.
  • No additional external dependencies beyond the API access are required.

Troubleshooting

  • Common issues:
    • Invalid or missing API credentials will cause authentication errors.
    • Providing invalid filter values (e.g., non-numeric IDs) may result in request failures.
    • Network connectivity problems can prevent successful API calls.
  • Error messages:
    • "Failed to retrieve submissions: <error message>" indicates an issue during the API request. Check API credentials, network, and filter parameters.
    • If no submissions are returned, verify that the filters and limit are set correctly and that there are matching submissions in DocuSeal.

Links and References

Discussion