Get Envelope

Retrieves detailed information about a specific envelope including its current status and metadata.

Overview

• Purpose: Get detailed status and information for a specific envelope.
• Use Cases: Tracking envelope progress, verifying completion, retrieving envelope details for reporting.
• API Method: GET /envelopes/:envelopeId

Required Input Fields

Envelope ID: The unique identifier of the envelope to retrieve. This is returned when creating envelopes or from ‘List Envelopes’.

Output

• Envelope ID: The envelope’s unique identifier.
• Status: Current status (created, sent, delivered, signed, completed, declined, voided).
• Email Subject: Subject line used for this envelope.
• Created DateTime: ISO 8601 timestamp when envelope was created.
• Sent DateTime: ISO 8601 timestamp when envelope was sent to recipients.
• Status Changed DateTime: ISO 8601 timestamp of the last status change.

Status Tracking

• Monitor Progress: Check status to see if envelope has been delivered, signed, or completed.
• Completion Detection: Status ‘completed’ indicates all signatures obtained and envelope finalized.
• Error Detection: Status ‘declined’ or ‘voided’ indicates envelope cannot proceed.
• Timestamp Tracking: Use status changed timestamp to track how long envelopes take to complete.

Tips

[!TIP] Poll this endpoint to track envelope progress in real-time

[!TIP] Use status to trigger workflow actions (e.g., notify when completed)

[!TIP] Store envelope IDs after creation for later status checking

[!TIP] Check sentDateTime to verify envelope was successfully delivered

[!TIP] Use statusChangedDateTime to calculate processing time

[!TIP] Combine with webhooks for event-driven status updates instead of polling