List Envelopes
Retrieves a list of envelopes from DocuSign with optional filtering by date range, status, and count limits.
Overview
- Purpose: Get a list of envelopes with filtering and pagination capabilities.
- Use Cases: Monitoring envelope status, auditing sent documents, building envelope dashboards, tracking pending signatures.
- API Method: GET /envelopes
Optional Input Fields
From Date: ISO 8601 date string to get envelopes created/modified after this date (e.g., ‘2025-01-01T00:00:00Z’).
To Date: ISO 8601 date string to get envelopes created/modified before this date.
Status: Filter by envelope status (e.g., ‘sent’, ‘delivered’, ‘completed’, ‘declined’, ‘voided’).
Count: Maximum number of envelopes to return (default varies, typically 100).
Envelope Status Values
- Created: Envelope created but not sent.
- Sent: Envelope sent to recipients.
- Delivered: Envelope delivered to at least one recipient.
- Signed: All required signatures obtained.
- Completed: Envelope fully executed and completed.
- Declined: Recipient declined to sign.
- Voided: Envelope was voided and cannot be signed.
Output
Returns an array of envelope objects, each containing:
- Envelope ID: Unique identifier for the envelope.
- Status: Current status of the envelope.
- Email Subject: Subject line used for the envelope.
- Created DateTime: When the envelope was created.
- Sent DateTime: When the envelope was sent.
- Status Changed DateTime: Last status change timestamp.
- Total Set Size: Total number of envelopes matching the filter criteria.
Filtering Best Practices
- Date Ranges: Use narrow date ranges for better performance with large accounts.
- Status Filtering: Filter by specific status to find actionable envelopes.
- Pagination: Use count parameter to manage large result sets.
- Incremental Sync: Use fromDate to get only new/updated envelopes since last check.
Tips
[!TIP] Use status filter to find envelopes requiring action (e.g., status=‘sent’)
[!TIP] Combine fromDate and status for efficient incremental syncing
[!TIP] Set appropriate count limits to avoid overwhelming API responses
[!TIP] Use date ranges to audit envelopes within specific time periods
[!TIP] Monitor ‘sent’ and ‘delivered’ statuses to track pending signatures
[!TIP] Store envelope IDs for detailed status tracking with ‘Get Envelope’