Envelopes: listAuditEvents

Gets the envelope audit events for the specified envelope.

Request

HTTP request

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/audit_events

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

envelopeIdstring

The envelope's GUID.

Example: 93be49ab-afa0-4adf-933c-f752070d71ec

Responses

CodeDescriptionReference
200

Successful response.

envelopeAuditEventResponse
400

Error encountered.

errorDetails

SDK Method

Envelopes::listAuditEvents

Definitions

envelopeAuditEvent

eventFields[nameValue]

envelopeAuditEventResponse

auditEvents[envelopeAuditEvent]

Reserved: TBD

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

nameValue

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

namestring

The name of the item.

originalValuestring

The initial value of the item.

valuestring

The current value of the item.

Examples

Generic JSON Response

Response
{
  "auditEvents": [
    {
      "eventFields": [
        {}
      ]
    }
  ]
}
Generic XML Response

Response
<envelopeAuditEventResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <auditEvents>
    <envelopeAuditEvent>
      <eventFields>
        <nameValue />
      </eventFields>
    </envelopeAuditEvent>
  </auditEvents>
</envelopeAuditEventResponse> 
}} />