Get a list of envelopes that match your request.

Note: Using this action requires to use at least one of the following parameters:

  • From Date
  • Envelope IDs
  • Transaction IDs

External Documentation

To learn more, visit the Docusign documentation.

​
Basic Parameters

ParameterDescription
Envelope IDsComma separated list of envelopeId values.
From DateThe date and time to start looking for status changes. This parameter is required unless the parameters Envelope IDs or Transaction IDs are set.
From To StatusThe status value checked for in the From Date to To Date time period.

For example:
* If Changed is specified, then envelopes that changed status during the period will be returned.
* If Created is specified, then envelopes created during the period are found.
To DateThe date and time to stop looking for status changes.

​
Advanced Parameters

ParameterDescription
Authoritative Copy StatusThe Authoritative Copy Status for the envelopes.
Custom FieldAn envelope custom field name and value searched for in the envelopes.

Format: custom_envelope_field_name=desired_value.

Example: If you have an envelope custom field named “Region” and you want to search for all envelopes where the value is “West” you would use set this parameter to Region=West.
EmailGet only envelopes sent by the account user with this email address.

User Name must be given as well, and both Email and User Name must refer to an existing account user.
StatusA list of current envelope statuses to included in the response.
Transaction IDsA comma separated list of envelope Transaction IDs. If included, this is a list of envelope Transaction IDs.
UsernameGet only envelopes sent by the account user with this user name.

Email must be given as well, and both Email and User Name must refer to an existing account user.

​
Example Output

{
	"resultSetSize": "<string>",
	"totalSetSize": "<string>",
	"startPosition": "<string>",
	"endPosition": "<string>",
	"nextUri": "<string>",
	"previousUri": "<string>",
	"envelopes": [
		{
			"status": "<string>",
			"documentsUri": "<string>",
			"recipientsUri": "<string>",
			"attachmentsUri": "<string>",
			"envelopeUri": "<string>",
			"envelopeId": "<string>",
			"customFieldsUri": "<string>",
			"notificationUri": "<string>",
			"statusChangedDateTime": "2025-04-06T11:41:02.0170000Z",
			"documentsCombinedUri": "<string>",
			"certificateUri": "<string>",
			"templatesUri": "<string>"
		}
	]
}

​
Workflow Library Example

Get Envelopes with Docusign and Send Results Via Email

Preview this Workflow on desktop