Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
Envelopes

Gets the status of a single envelope.

Retrieves the overall status for the specified envelope. To get the status of a list of envelopes, use Envelope: listStatusChanges .

Related topics

  • How to get envelope information
get/v2.1/accounts/{accountId}/envelopes/{envelopeId}

Path parameters

accountIdstring required

The external account number (int) or account ID GUID.

envelopeIdstring required

The envelope's GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Query parameters

advanced_updatestring

When true, envelope information can be added or modified.

includestring

Specifies additional information about the envelope to return. Enter a comma-separated list, such as tabs,recipients. Valid values are:

  • custom_fields: The custom fields associated with the envelope.
  • documents: The documents associated with the envelope.
  • attachments: The attachments associated with the envelope.
  • extensions: The email settings associated with the envelope.
  • folders: The folder where the envelope exists.
  • recipients: The recipients associated with the envelope.
  • powerform: The PowerForms associated with the envelope.
  • prefill_tabs: The pre-filled tabs associated with the envelope.
  • tabs: The tabs associated with the envelope.
  • payment_tabs: The payment tabs associated with the envelope.
  • workflow: The workflow definition associated with the envelope.
include_anchor_tab_locationsstring

When true, all tabs with anchor tab properties are included in the response. The default value is false.

user_idstring

Response

Successful response.