--- title: "Get envelope audit logs" method: GET path: "/envelope/{envelopeId}/audit-log" tags: ["Envelope"] --- # Get envelope audit logs `GET /envelope/{envelopeId}/audit-log` Find audit logs based on a search criteria ## Path parameters - `envelopeId` string, required ## Query parameters - `page` number - `perPage` number - `orderByColumn` 'createdAt' - `orderByDirection` 'asc' | 'desc' ## Response `200` Successful response - object - `data` union[], required - union - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'ENVELOPE_ITEM_CREATED', required - `data` object, required - `envelopeItemId` string, required - `envelopeItemTitle` string, required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'ENVELOPE_ITEM_DELETED', required - `data` object, required - `envelopeItemId` string, required - `envelopeItemTitle` string, required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'ENVELOPE_ITEM_UPDATED', required - `data` object, required - `envelopeItemId` string, required - `changes` object[], required - `field` string, required - `from` string, required - `to` string, required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'ENVELOPE_ITEM_PDF_REPLACED', required - `data` object, required - `envelopeItemId` string, required - `envelopeItemTitle` string, required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'EMAIL_SENT', required - `data` object, required - `recipientEmail` string, required - `recipientName` string, required - `recipientId` number, required - `recipientRole` string, required - `emailType` 'SIGNING_REQUEST' | 'VIEW_REQUEST' | 'APPROVE_REQUEST' | 'ASSISTING_REQUEST' | 'CC' | 'DOCUMENT_COMPLETED' | 'REMINDER', required - `isResending` boolean, required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_COMPLETED', required - `data` object, required - `transactionId` string, required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_CREATED', required - `data` object, required - `title` string, required - `source` union - object - … - object - … - object - … - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_DELETED', required - `data` object, required - `type` 'SOFT' | 'HARD', required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_CANCELLED', required - `data` object, required - `reason` string - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_MOVED_TO_TEAM', required - `data` object, required - `movedByUserId` number, required - `fromPersonalAccount` boolean, required - `toTeamId` number, required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_DELEGATED_OWNER_CREATED', required - `data` object, required - `delegatedOwnerName` string, nullable, required - `delegatedOwnerEmail` string, required - `teamName` string, required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_FIELDS_AUTO_INSERTED', required - `data` object, required - `fields` object[], required - `fieldId` number, required - `fieldType` 'SIGNATURE' | 'FREE_SIGNATURE' | 'INITIALS' | 'NAME' | 'EMAIL' | 'DATE' | 'TEXT' | 'NUMBER' | 'RADIO' | 'CHECKBOX' | 'DROPDOWN', required - `recipientId` number, required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_FIELD_INSERTED', required - `data` object, required - `recipientEmail` string, required - `recipientName` string, required - `recipientId` number, required - `recipientRole` string, required - `fieldId` string, required - `field` union, required - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `fieldSecurity` object - `type` 'ACCOUNT' | 'PASSKEY' | 'TWO_FACTOR_AUTH' | 'PASSWORD' | 'EXPLICIT_NONE' - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_FIELD_UNINSERTED', required - `data` object, required - `field` 'SIGNATURE' | 'FREE_SIGNATURE' | 'INITIALS' | 'NAME' | 'EMAIL' | 'DATE' | 'TEXT' | 'NUMBER' | 'RADIO' | 'CHECKBOX' | 'DROPDOWN', required - `fieldId` string, required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_FIELD_PREFILLED', required - `data` object, required - `recipientEmail` string, required - `recipientName` string, required - `recipientId` number, required - `recipientRole` string, required - `fieldId` string, required - `field` union, required - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `fieldSecurity` object - `type` 'ACCOUNT' | 'PASSKEY' | 'TWO_FACTOR_AUTH' | 'PASSWORD' | 'EXPLICIT_NONE' - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_VISIBILITY_UPDATED', required - `data` object, required - `from` union, required - string - string[] - `to` union, required - string - string[] - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_GLOBAL_AUTH_ACCESS_UPDATED', required - `data` object, required - `from` union, required - string - string[] - `to` union, required - string - string[] - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_GLOBAL_AUTH_ACTION_UPDATED', required - `data` object, required - `from` union, required - string - string[] - `to` union, required - string - string[] - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_META_UPDATED', required - `data` object, required - `changes` union[], required - union - … - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_OPENED', required - `data` object, required - `recipientEmail` string, required - `recipientName` string, required - `recipientId` number, required - `recipientRole` string, required - `accessAuth` string[], required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_VIEWED', required - `data` object, required - `recipientEmail` string, required - `recipientName` string, required - `recipientId` number, required - `recipientRole` string, required - `accessAuth` string[], required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_RECIPIENT_COMPLETED', required - `data` object, required - `recipientEmail` string, required - `recipientName` string, required - `recipientId` number, required - `recipientRole` string, required - `actionAuth` string[], required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_RECIPIENT_REJECTED', required - `data` object, required - `recipientEmail` string, required - `recipientName` string, required - `recipientId` number, required - `recipientRole` string, required - `reason` string, required - `isExternal` boolean - `onBehalfOfUserEmail` string - `onBehalfOfUserName` string, nullable - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_ACCESS_AUTH_2FA_REQUESTED', required - `data` object, required - `recipientEmail` string, required - `recipientName` string, required - `recipientId` number, required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_ACCESS_AUTH_2FA_VALIDATED', required - `data` object, required - `recipientEmail` string, required - `recipientName` string, required - `recipientId` number, required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_ACCESS_AUTH_2FA_FAILED', required - `data` object, required - `recipientEmail` string, required - `recipientName` string, required - `recipientId` number, required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_SENT', required - `data` object, required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_TITLE_UPDATED', required - `data` object, required - `from` string, required - `to` string, required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_EXTERNAL_ID_UPDATED', required - `data` object, required - `from` string, nullable - `to` string, nullable - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'FIELD_CREATED', required - `data` object, required - `fieldId` string, required - `fieldRecipientEmail` string, required - `fieldRecipientId` number, required - `fieldType` string, required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'FIELD_DELETED', required - `data` object, required - `fieldId` string, required - `fieldRecipientEmail` string, required - `fieldRecipientId` number, required - `fieldType` string, required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'FIELD_UPDATED', required - `data` object, required - `fieldId` string, required - `fieldRecipientEmail` string, required - `fieldRecipientId` number, required - `fieldType` string, required - `changes` union[], required - union - … - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'RECIPIENT_CREATED', required - `data` object, required - `recipientEmail` string, required - `recipientName` string, required - `recipientId` number, required - `recipientRole` string, required - `accessAuth` string[], required - `actionAuth` string[], required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'RECIPIENT_UPDATED', required - `data` object, required - `recipientEmail` string, required - `recipientName` string, required - `recipientId` number, required - `recipientRole` string, required - `changes` union[], required - union - … - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'RECIPIENT_DELETED', required - `data` object, required - `recipientEmail` string, required - `recipientName` string, required - `recipientId` number, required - `recipientRole` string, required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_RECIPIENT_EXPIRED', required - `data` object, required - `recipientEmail` string, required - `recipientName` string, required - `recipientId` number, required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_RECIPIENT_CSC_AUTHENTICATED', required - `data` object, required - `recipientEmail` string, required - `recipientName` string, required - `recipientId` number, required - `recipientRole` string, required - `providerId` string, required - `credentialId` string, required - `signatureAlgorithm` string, required - `digestAlgorithm` string, required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_RECIPIENT_CSC_AUTHENTICATION_FAILED', required - `data` object, required - `recipientEmail` string, required - `recipientName` string, required - `recipientId` number, required - `recipientRole` string, required - `providerId` string, required - `reason` string, required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_RECIPIENT_CSC_SIGN_REQUESTED', required - `data` object, required - `recipientEmail` string, required - `recipientName` string, required - `recipientId` number, required - `recipientRole` string, required - `providerId` string, required - `credentialId` string, required - `sessionId` string, required - `numSignatures` number, required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_RECIPIENT_CSC_AUTHORIZED', required - `data` object, required - `recipientEmail` string, required - `recipientName` string, required - `recipientId` number, required - `recipientRole` string, required - `providerId` string, required - `credentialId` string, required - `sessionId` string, required - `sadExpiresAt` string, required - object - `id` string, required - `createdAt` string, required - `envelopeId` string, required - `name` string, nullable - `email` string, nullable - `userId` number, nullable - `userAgent` string, nullable - `ipAddress` string, nullable - `type` 'DOCUMENT_RECIPIENT_CSC_SIGNED', required - `data` object, required - `recipientEmail` string, required - `recipientName` string, required - `recipientId` number, required - `recipientRole` string, required - `providerId` string, required - `credentialId` string, required - `sessionId` string, required - `numItemsSigned` number, required - `signatureAlgorithm` string, required - `digestAlgorithm` string, required - `count` number, required - `currentPage` number, required - `perPage` number, required - `totalPages` number, required ## Other responses - `400` — Invalid input data - `401` — Authorization not provided - `403` — Insufficient access - `404` — Not found - `500` — Internal server error --- [API](https://skmtc.net/documenso/apis/documenso-v2-api.md) · [All operations](https://skmtc.net/documenso/apis/documenso-v2-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/documenso/documenso-v2-api/revisions/3db245102197/schema)