DocuSeal icon

DocuSeal

Create documents, manage templates, and handle submissions with DocuSeal

Actions9

Overview

The DocuSeal Submitter: Get operation retrieves detailed information about a specific submitter from the DocuSeal platform using their unique ID. This node is useful in workflows where you need to fetch and process data related to an individual who has been assigned or completed a document submission, such as for auditing, reporting, or follow-up communication.

Example scenarios:

  • Fetching submitter details to send personalized notifications.
  • Retrieving submitter status for compliance checks.
  • Integrating submitter data into CRM or other business systems.

Properties

Display Name Type Description
Environment options Choose between production and test environment.
Submitter ID number ID of the submitter to retrieve. (Required)

Output

The output will be a JSON object containing all available details about the requested submitter. The structure depends on the DocuSeal API response, but typically includes fields such as:

{
  "id": 123,
  "name": "John Doe",
  "email": "john.doe@example.com",
  "role": "Signer",
  "status": "completed",
  "submission_id": 456,
  "completed_at": "2024-06-01T12:34:56Z",
  // ...other submitter-specific fields
}
  • All fields are returned as provided by the DocuSeal API.
  • No binary data is produced by this operation.

Dependencies

  • External Service: Requires access to the DocuSeal API.
  • API Credentials: You must configure valid DocuSeal API credentials in n8n under the name docusealApi.
  • Environment Selection: Make sure to select the correct environment (production or test) as per your use case.

Troubleshooting

Common Issues:

  • Invalid Submitter ID: If the provided Submitter ID does not exist, the node will return an error message indicating that the submitter was not found.
  • Authentication Errors: Missing or incorrect API credentials will result in authentication failures.
  • Environment Mismatch: Selecting the wrong environment may cause the node to not find the expected submitter.

Error Messages & Resolutions:

  • "Submitters parameter must be a valid array with at least one submitter object": Ensure you provide a valid Submitter ID.
  • "Error creating submission: ...": Not applicable for 'get' operation, but indicates issues with API requests—check credentials and input values.
  • For any error in the API call, the node will output an error message in the json.error field if "Continue On Fail" is enabled.

Links and References

Discussion