DocuSeal icon

DocuSeal

Create documents, manage templates, and handle submissions with DocuSeal

Actions23

Overview

This node interacts with the "Submitter" resource of the DocuSeal API, specifically supporting the "Get Many" operation. It retrieves multiple submitter records based on various filtering criteria and a limit on the number of results returned.

Typical use cases include:

  • Fetching a list of submitters who completed submissions within a certain date range.
  • Retrieving submitters filtered by external IDs or submission IDs.
  • Paginating through submitters using cursor-based pagination (after/before ID).
  • Searching submitters by name, email, or phone.

For example, you might use this node to get all submitters who completed their submissions after January 1, 2024, limiting the results to 100 entries for further processing or reporting.

Properties

Name Meaning
Limit Maximum number of submitter records to return. Minimum value is 1.
Filters Collection of optional filters to narrow down the submitters retrieved:
- After ID: Fetch submitters with ID greater than this value (cursor-based pagination).
- Before ID: Fetch submitters with ID less than this value (cursor-based pagination).
- Completed After: Filter submitters who completed after this date/time.
- Completed Before: Filter submitters who completed before this date/time.
- External ID: Filter submitters by an external identifier string.
- Search Query: Search submitters by name, email, or phone containing this string.
- Submission ID: Filter submitters associated with a specific submission ID (number).

Output

The node outputs an array of JSON objects representing submitters matching the specified filters and limit. Each object corresponds to a submitter's data as returned by the DocuSeal API.

The exact structure depends on the API response but typically includes fields such as submitter ID, name, contact details, completion status, and timestamps.

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 format dates and validate parameters.
  • No additional external dependencies beyond the DocuSeal API are required.

Troubleshooting

  • Common issues:

    • Invalid date formats in "Completed After" or "Completed Before" filters may cause errors.
    • Providing non-numeric values for "After ID", "Before ID", or "Submission ID" will result in request failures.
    • Exceeding API rate limits or network connectivity problems can cause request failures.

  • Error messages:

    • "Failed to retrieve submitters: <error message>" indicates an issue communicating with the API or invalid parameters. Check your filter values and API credentials.
    • "At least one submitter is required" does not apply here but may appear in other operations if submitter data is missing.

  • Resolution tips:

    • Ensure date/time filters are correctly formatted ISO strings.
    • Use numeric values for ID filters.
    • Verify that the API key credential is valid and has sufficient permissions.
    • If paginating, adjust "After ID" and "Before ID" carefully to avoid empty results.

Links and References

Discussion