DocuSeal icon

DocuSeal

Create documents, manage templates, and handle submissions with DocuSeal

Actions23

Overview

This node integrates with the DocuSeal API to manage document submissions. Specifically, the "Submission" resource with the "Get" operation retrieves detailed information about a single submission by its ID. This is useful when you want to fetch the status, metadata, or other details of a particular document submission that was previously created or processed.

Common scenarios include:

  • Checking the status or details of a specific submission after it has been sent out.
  • Retrieving submission data for audit or reporting purposes.
  • Integrating submission details into workflows that depend on submission state or content.

Example: You have a workflow that sends documents for signature and later needs to verify if a particular submission has been completed or retrieve its metadata. Using this node operation, you can fetch that submission's full details by providing its Submission ID.

Properties

Name Meaning
Submission ID The unique numeric identifier of the submission to retrieve.

Output

The output is a JSON object representing the submission details as returned by the DocuSeal API endpoint /submissions/{submissionId}. This typically includes all relevant information about the submission such as its status, associated template, submitters, field values, timestamps, and metadata.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the DocuSeal API via an API key credential configured in n8n.
  • The node uses internal helper functions to make authenticated HTTP requests to DocuSeal endpoints.
  • No additional external dependencies beyond the DocuSeal API and proper credential setup.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Submission ID will likely result in an error from the API indicating the submission was not found.
    • Network or authentication errors if the API key credential is missing, expired, or incorrect.

  • Error messages:

    • "Failed to retrieve submissions: <error message>" — indicates a problem fetching submissions; check the Submission ID and API connectivity.
    • "Invalid file URL" or similar errors do not apply to this operation but may appear in other operations.

  • Resolution tips:

    • Verify the Submission ID is correct and exists in your DocuSeal account.
    • Ensure the API key credential is properly configured and has necessary permissions.
    • Check network connectivity and API service status.

Links and References

Discussion