DocuSeal icon

DocuSeal

Create documents, manage templates, and handle submissions with DocuSeal

Actions23

Overview

This node interacts with the DocuSeal API to manage submitters and their data. Specifically, the "Submitter" resource with the "Get" operation retrieves detailed information about a particular submitter by their ID. This is useful in workflows where you need to fetch submitter details for document submissions, track user interactions, or integrate submitter data into other systems.

Practical example:
You have a workflow that processes document submissions and needs to retrieve the profile or status of a submitter by their unique ID to personalize communications or update records in a CRM system.

Properties

Name Meaning
Submitter ID The unique numeric identifier of the submitter whose details you want to retrieve.

Output

The output is a JSON object representing the submitter's data as returned by the DocuSeal API. It typically includes all relevant fields describing the submitter, such as their name, contact information, submission history, and any custom metadata associated with them.

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 depends on the docusealApiRequest helper function to make authenticated HTTP requests to the DocuSeal service.

Troubleshooting

  • Common issues:

    • Invalid or missing Submitter ID will cause the request to fail.
    • Network or authentication errors if the API key is invalid or expired.
    • If the submitter does not exist, the API may return a 404 error.

  • Error messages:

    • "Failed to retrieve submitter: <error message>" indicates an issue fetching the submitter data. Verify the Submitter ID and API credentials.
    • "Invalid file URL" or similar errors are unrelated to this operation but may appear if other operations are used incorrectly.

To resolve errors:

  • Ensure the Submitter ID is correct and exists in DocuSeal.
  • Confirm the API key credential is valid and has necessary permissions.
  • Check network connectivity and API endpoint availability.

Links and References

Discussion