Envelopes: listAuditEvents

Gets the envelope audit events for the specified envelope.

Request

HTTP request

GET /v2/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. Eg 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

An error code associated with the error.

messagestring

A short error message.

nameValue

errorDetailserrorDetails

namestring

The name or key of a name/value pair.

originalValuestring

The initial value of the tab when it was sent to the recipient.

valuestring

The value field of a name/value pair.

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> 
}} />