Get Envelope Audit Trail

This document contains details for the GET /api/v1/audittrail/envelope/{uuid} endpoint, including the request method, path parameter, and response status codes.

Method

Method	GET
URL	/api/v1/audittrail/envelope/{uuid}
Authorization	Bearer {token}
Content-Type	application/json

Use this endpoint to get the audit trail record for an envelope. Pass the envelope UUID in the request path.

Use this endpoint when you need raw audit trail data in the API response. Read this record to inspect the envelope history, track participant actions, or store the audit trail in an external system.

Path parameters

Parameter	Type	Required	Description
uuid	string	Yes	Envelope UUID

How it works

1. Pass the envelope UUID in the request path.

2. Send a GET request.

3. Read the current audit trail record from the response.

Response format

The response returns the audit trail record for the specified envelope.

The exact field set depends on the stored audit trail record. The response typically includes:

• envelope details

• participant details

• event history with timestamps

Response structure example

This example shows the general response shape.

{
  "envelope": {
    "uuid": "8949955d-3bf7-4d9f-97d0-111111111111",
    "status": "COMPLETED"
  },
  "participants": [
    {
      "roleId": "23f20eec-adad-4325-b553-1bde4be29198",
      "mailboxUuid": "9baec31c-e940-4894-b6d1-52033e1af66e"
    }
  ],
  "events": [
    {
      "type": "SENT",
      "date": "2026-06-04T10:15:00Z"
    },
    {
      "type": "COMPLETED",
      "date": "2026-06-04T10:45:00Z"
    }
  ]
}

Read Swagger UI for the exact response schema.

Response status codes

Code	Description
200	Success
401	Not authorized
403	No access to mailbox
404	Envelope not found

Related topics

• Create Audit Trail Record

• Export Envelope Audit Trail PDF File