DocuSeal icon

DocuSeal

Create documents, manage templates, and handle submissions with DocuSeal

Actions9

Overview

The DocuSeal Submitter: Get List operation retrieves a list of submitters from the DocuSeal platform, allowing you to filter and paginate results based on various criteria. This node is useful for automating workflows that require access to participant or signer information in document processes, such as reporting, follow-up communications, or integration with CRM systems.

Practical examples:

  • Fetch all submitters who completed documents after a certain date for compliance tracking.
  • Retrieve submitters associated with a specific submission for targeted notifications.
  • Search for submitters by external ID or partial name/email/phone match for data reconciliation.

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).
After ID number Return submitters with ID greater than this value.
Before ID number Return submitters with ID less than this value.
Completed After dateTime Filter submitters that completed after this date and time.
Completed Before dateTime Filter submitters that completed before this date and time.
External ID string Filter submitters by external ID.
Query string Filter submitters on name, email, or phone partial match.
Submission ID number Filter submitters by submission ID.

Output

The output is an array of JSON objects, each representing a submitter. The structure typically includes fields such as:

{
  "id": 123,
  "name": "John Doe",
  "email": "john.doe@example.com",
  "role": "Signer",
  "completed": true,
  "completed_at": "2024-05-01T12:34:56Z",
  "external_id": "abc-123",
  "submission_id": 456,
  // ...other submitter-specific fields
}
  • Each object contains details about a submitter matching the specified filters.
  • If an error occurs and "Continue On Fail" is enabled, the output will include an error field with the error message.

Dependencies

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

Troubleshooting

Common Issues:

  • Invalid Credentials: If API credentials are missing or incorrect, authentication errors will occur.
  • Filter Mismatch: Using incompatible or invalid filter values may result in empty results or API errors.
  • Rate Limiting: Excessive requests may trigger rate limits on the DocuSeal API.

Error Messages:

  • "Submitters parameter must be a valid array with at least one submitter object": This should not occur in "Get List", but indicates a misconfiguration if seen.
  • "Error creating submission: ...": Not relevant for "Get List", but may appear if the wrong operation is selected.
  • If "Continue On Fail" is enabled, errors are returned in the output as { "error": "Error message" }.

How to resolve:

  • Double-check API credentials and permissions.
  • Ensure filter values are within expected ranges and formats.
  • Reduce request frequency if hitting rate limits.

Links and References

Discussion