Envelopes: listAuditEvents

Gets the envelope audit events for the specified envelope.

Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
accountId string

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

envelopeId string

The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Envelopes::listAuditEvents

Definitions Expand All | Collapse All

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.

errorCode string

An error code associated with the error.

message string

A short error message.

nameValue

errorDetails errorDetails
name string

The name or key of a name/value pair.

originalValue string

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

value string

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>