Get envelope audit logs

GET

/envelope/{envelopeId}/audit-log

curl --request GET \
  --url 'https://app.legaldoc.com/api/v2/envelope/example/audit-log?orderByColumn=createdAt&orderByDirection=asc' \
  --header 'Authorization: <Authorization>'

Find audit logs based on a search criteria

Authorizations

• apiKey

Parameters

Path Parameters

envelopeId

required

string

Envelope ID

Query Parameters

page

number

>= 1

The pagination page number, starts at 1.

perPage

number

>= 1 <= 100

The number of items per page.

orderByColumn

string

Allowed values: createdAt

orderByDirection

string

Allowed values: asc desc

Responses

200

Successful response

Media typeapplication/json

object

data

required

Array

object

id

required

string

createdAt

required

string

envelopeId

required

string

name

string | null

email

string | null

userId

number | null

userAgent

string | null

ipAddress

string | null

Any of:

object

object

type

required

string

Allowed values: ENVELOPE_ITEM_CREATED

data

required

object

envelopeItemId

required

string

envelopeItemTitle

required

string

object

object

type

required

string

Allowed values: ENVELOPE_ITEM_DELETED

data

required

object

envelopeItemId

required

string

envelopeItemTitle

required

string

object

object

type

required

string

Allowed values: ENVELOPE_ITEM_UPDATED

data

required

object

envelopeItemId

required

string

changes

required

Array<object>

object

field

required

string

from

required

string

to

required

string

object

object

type

required

string

Allowed values: ENVELOPE_ITEM_PDF_REPLACED

data

required

object

envelopeItemId

required

string

envelopeItemTitle

required

string

object

object

type

required

string

Allowed values: EMAIL_SENT

data

required

object

recipientEmail

required

string

recipientName

required

string

recipientId

required

number

recipientRole

required

string

emailType

required

string

Allowed values: SIGNING_REQUEST VIEW_REQUEST APPROVE_REQUEST ASSISTING_REQUEST CC DOCUMENT_COMPLETED REMINDER

isResending

required

boolean

object

object

type

required

string

Allowed values: DOCUMENT_COMPLETED

data

required

object

transactionId

required

string

object

object

type

required

string

Allowed values: DOCUMENT_CREATED

data

required

object

title

required

string

source

Any of:

object

object

type

required

string

Allowed values: DOCUMENT

object

object

type

required

string

Allowed values: TEMPLATE

templateId

required

number

object

object

type

required

string

Allowed values: TEMPLATE_DIRECT_LINK

templateId

required

number

directRecipientEmail

required

string

/^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\u{0080}-\u{FFFF}-]+@[a-zA-Z0-9\u{0080}-\u{FFFF}](?:[a-zA-Z0-9\u{0080}-\u{FFFF}-]{0,61}[a-zA-Z0-9\u{0080}-\u{FFFF}])?(?:\.[a-zA-Z0-9\u{0080}-\u{FFFF}](?:[a-zA-Z0-9\u{0080}-\u{FFFF}-]{0,61}[a-zA-Z0-9\u{0080}-\u{FFFF}])?)*$/

object

object

type

required

string

Allowed values: DOCUMENT_DELETED

data

required

object

type

required

string

Allowed values: SOFT HARD

object

object

type

required

string

Allowed values: DOCUMENT_CANCELLED

data

required

object

reason

string

object

object

type

required

string

Allowed values: DOCUMENT_MOVED_TO_TEAM

data

required

object

movedByUserId

required

number

fromPersonalAccount

required

boolean

toTeamId

required

number

object

object

type

required

string

Allowed values: DOCUMENT_DELEGATED_OWNER_CREATED

data

required

object

delegatedOwnerName

required

string | null

delegatedOwnerEmail

required

string

teamName

required

string

object

object

type

required

string

Allowed values: DOCUMENT_FIELDS_AUTO_INSERTED

data

required

object

fields

required

Array<object>

object

fieldId

required

number

fieldType

required

string

Allowed values: SIGNATURE FREE_SIGNATURE INITIALS NAME EMAIL DATE TEXT NUMBER RADIO CHECKBOX DROPDOWN

recipientId

required

number

object

object

type

required

string

Allowed values: DOCUMENT_FIELD_INSERTED

data

required

object

recipientEmail

required

string

recipientName

required

string

recipientId

required

number

recipientRole

required

string

fieldId

required

string

field

required

Any of:

object

object

type

required

string

Allowed values: INITIALS

data

required

string

object

object

type

required

string

Allowed values: EMAIL

data

required

string

object

object

type

required

string

Allowed values: DATE

data

required

string

object

object

type

required

string

Allowed values: NAME

data

required

string

object

object

type

required

string

Allowed values: TEXT

data

required

string

object

object

type

required

Any of:

string

string

Allowed values: SIGNATURE

string

string

Allowed values: FREE_SIGNATURE

data

required

string

object

object

type

required

string

Allowed values: RADIO

data

required

string

object

object

type

required

string

Allowed values: CHECKBOX

data

required

string

object

object

type

required

string

Allowed values: DROPDOWN

data

required

string

object

object

type

required

string

Allowed values: NUMBER

data

required

string

fieldSecurity

object

type

string

Allowed values: ACCOUNT PASSKEY TWO_FACTOR_AUTH PASSWORD EXPLICIT_NONE

object

object

type

required

string

Allowed values: DOCUMENT_FIELD_UNINSERTED

data

required

object

field

required

string

Allowed values: SIGNATURE FREE_SIGNATURE INITIALS NAME EMAIL DATE TEXT NUMBER RADIO CHECKBOX DROPDOWN

fieldId

required

string

object

object

type

required

string

Allowed values: DOCUMENT_FIELD_PREFILLED

data

required

object

recipientEmail

required

string

recipientName

required

string

recipientId

required

number

recipientRole

required

string

fieldId

required

string

field

required

Any of:

object

object

type

required

string

Allowed values: INITIALS

data

required

string

object

object

type

required

string

Allowed values: EMAIL

data

required

string

object

object

type

required

string

Allowed values: DATE

data

required

string

object

object

type

required

string

Allowed values: NAME

data

required

string

object

object

type

required

string

Allowed values: TEXT

data

required

string

object

object

type

required

Any of:

string

string

Allowed values: SIGNATURE

string

string

Allowed values: FREE_SIGNATURE

data

required

string

object

object

type

required

string

Allowed values: RADIO

data

required

string

object

object

type

required

string

Allowed values: CHECKBOX

data

required

string

object

object

type

required

string

Allowed values: DROPDOWN

data

required

string

object

object

type

required

string

Allowed values: NUMBER

data

required

string

fieldSecurity

object

type

string

Allowed values: ACCOUNT PASSKEY TWO_FACTOR_AUTH PASSWORD EXPLICIT_NONE

object

object

type

required

string

Allowed values: DOCUMENT_VISIBILITY_UPDATED

data

required

object

from

required

Any of:

string

string

Array<string>

Array<string>

to

required

Any of:

string

string

Array<string>

Array<string>

object

object

type

required

string

Allowed values: DOCUMENT_GLOBAL_AUTH_ACCESS_UPDATED

data

required

object

from

required

Any of:

string

string

Array<string>

Array<string>

to

required

Any of:

string

string

Array<string>

Array<string>

object

object

type

required

string

Allowed values: DOCUMENT_GLOBAL_AUTH_ACTION_UPDATED

data

required

object

from

required

Any of:

string

string

Array<string>

Array<string>

to

required

Any of:

string

string

Array<string>

Array<string>

object

object

type

required

string

Allowed values: DOCUMENT_META_UPDATED

data

required

object

changes

required

Array

Any of:

object

object

type

required

Any of:

string

string

Allowed values: DATE_FORMAT

string

string

Allowed values: MESSAGE

string

string

Allowed values: REDIRECT_URL

string

string

Allowed values: SUBJECT

string

string

Allowed values: TIMEZONE

string

string

Allowed values: EMAIL_ID

string

string

Allowed values: EMAIL_REPLY_TO

string

string

Allowed values: EMAIL_SETTINGS

from

required

string | null

to

required

string | null

object

object

type

required

string

Allowed values: PASSWORD

object

object

type

required

string

Allowed values: DOCUMENT_OPENED

data

required

object

recipientEmail

required

string

recipientName

required

string

recipientId

required

number

recipientRole

required

string

accessAuth

required

Array<string>

Allowed values: ACCOUNT TWO_FACTOR_AUTH

object

object

type

required

string

Allowed values: DOCUMENT_VIEWED

data

required

object

recipientEmail

required

string

recipientName

required

string

recipientId

required

number

recipientRole

required

string

accessAuth

required

Array<string>

Allowed values: ACCOUNT TWO_FACTOR_AUTH

object

object

type

required

string

Allowed values: DOCUMENT_RECIPIENT_COMPLETED

data

required

object

recipientEmail

required

string

recipientName

required

string

recipientId

required

number

recipientRole

required

string

actionAuth

required

Array<string>

Allowed values: ACCOUNT PASSKEY TWO_FACTOR_AUTH PASSWORD EXPLICIT_NONE

object

object

type

required

string

Allowed values: DOCUMENT_RECIPIENT_REJECTED

data

required

object

recipientEmail

required

string

recipientName

required

string

recipientId

required

number

recipientRole

required

string

reason

required

string

isExternal

boolean

onBehalfOfUserEmail

string

onBehalfOfUserName

string | null

object

object

type

required

string

Allowed values: DOCUMENT_ACCESS_AUTH_2FA_REQUESTED

data

required

object

recipientEmail

required

string

recipientName

required

string

recipientId

required

number

object

object

type

required

string

Allowed values: DOCUMENT_ACCESS_AUTH_2FA_VALIDATED

data

required

object

recipientEmail

required

string

recipientName

required

string

recipientId

required

number

object

object

type

required

string

Allowed values: DOCUMENT_ACCESS_AUTH_2FA_FAILED

data

required

object

recipientEmail

required

string

recipientName

required

string

recipientId

required

number

object

object

type

required

string

Allowed values: DOCUMENT_SENT

data

required

object

object

object

type

required

string

Allowed values: DOCUMENT_TITLE_UPDATED

data

required

object

from

required

string

to

required

string

object

object

type

required

string

Allowed values: DOCUMENT_EXTERNAL_ID_UPDATED

data

required

object

from

string | null

to

string | null

object

object

type

required

string

Allowed values: FIELD_CREATED

data

required

object

fieldId

required

string

fieldRecipientEmail

required

string

fieldRecipientId

required

number

fieldType

required

string

object

object

type

required

string

Allowed values: FIELD_DELETED

data

required

object

fieldId

required

string

fieldRecipientEmail

required

string

fieldRecipientId

required

number

fieldType

required

string

object

object

type

required

string

Allowed values: FIELD_UPDATED

data

required

object

fieldId

required

string

fieldRecipientEmail

required

string

fieldRecipientId

required

number

fieldType

required

string

changes

required

Array

Any of:

object

object

type

required

string

Allowed values: DIMENSION

from

required

object

width

required

number

height

required

number

to

required

object

width

required

number

height

required

number

object

object

type

required

string

Allowed values: POSITION

from

required

object

page

required

number

positionX

required

number

positionY

required

number

to

required

object

page

required

number

positionX

required

number

positionY

required

number

object

object

type

required

string

Allowed values: RECIPIENT_CREATED

data

required

object

recipientEmail

required

string

recipientName

required

string

recipientId

required

number

recipientRole

required

string

accessAuth

required

Array<string>

Allowed values: ACCOUNT TWO_FACTOR_AUTH

actionAuth

required

Array<string>

Allowed values: ACCOUNT PASSKEY TWO_FACTOR_AUTH PASSWORD EXPLICIT_NONE

object

object

type

required

string

Allowed values: RECIPIENT_UPDATED

data

required

object

recipientEmail

required

string

recipientName

required

string

recipientId

required

number

recipientRole

required

string

changes

required

Array

One of:

object

object

from

required

Any of:

string

string

Array<string>

Array<string>

to

required

Any of:

string

string

Array<string>

Array<string>

type

required

string

Allowed values: ACTION_AUTH

object

object

from

required

Any of:

string

string

Array<string>

Array<string>

to

required

Any of:

string

string

Array<string>

Array<string>

type

required

string

Allowed values: ACCESS_AUTH

object

object

from

required

Any of:

string

string

Array<string>

Array<string>

to

required

Any of:

string

string

Array<string>

Array<string>

type

required

string

Allowed values: NAME

object

object

from

required

Any of:

string

string

Array<string>

Array<string>

to

required

Any of:

string

string

Array<string>

Array<string>

type

required

string

Allowed values: ROLE

object

object

from

required

Any of:

string

string

Array<string>

Array<string>

to

required

Any of:

string

string

Array<string>

Array<string>

type

required

string

Allowed values: EMAIL

object

object

type

required

string

Allowed values: RECIPIENT_DELETED

data

required

object

recipientEmail

required

string

recipientName

required

string

recipientId

required

number

recipientRole

required

string

object

object

type

required

string

Allowed values: DOCUMENT_RECIPIENT_EXPIRED

data

required

object

recipientEmail

required

string

recipientName

required

string

recipientId

required

number

object

object

type

required

string

Allowed values: DOCUMENT_RECIPIENT_CSC_AUTHENTICATED

data

required

object

recipientEmail

required

string

recipientName

required

string

recipientId

required

number

recipientRole

required

string

providerId

required

string

credentialId

required

string

signatureAlgorithm

required

string

digestAlgorithm

required

string

object

object

type

required

string

Allowed values: DOCUMENT_RECIPIENT_CSC_AUTHENTICATION_FAILED

data

required

object

recipientEmail

required

string

recipientName

required

string

recipientId

required

number

recipientRole

required

string

providerId

required

string

reason

required

string

object

object

type

required

string

Allowed values: DOCUMENT_RECIPIENT_CSC_SIGN_REQUESTED

data

required

object

recipientEmail

required

string

recipientName

required

string

recipientId

required

number

recipientRole

required

string

providerId

required

string

credentialId

required

string

sessionId

required

string

numSignatures

required

number

object

object

type

required

string

Allowed values: DOCUMENT_RECIPIENT_CSC_AUTHORIZED

data

required

object

recipientEmail

required

string

recipientName

required

string

recipientId

required

number

recipientRole

required

string

providerId

required

string

credentialId

required

string

sessionId

required

string

sadExpiresAt

required

string

object

object

type

required

string

Allowed values: DOCUMENT_RECIPIENT_CSC_SIGNED

data

required

object

recipientEmail

required

string

recipientName

required

string

recipientId

required

number

recipientRole

required

string

providerId

required

string

credentialId

required

string

sessionId

required

string

numItemsSigned

required

number

signatureAlgorithm

required

string

digestAlgorithm

required

string

count

required

number

currentPage

required

number

perPage

required

number

totalPages

required

number

Example

{
  "data": [
    {
      "type": "ENVELOPE_ITEM_CREATED"
    }
  ]
}

400

Invalid input data

Media typeapplication/json

object

message

required

string

code

required

string

issues

Array<object>

object

message

required

string

Example^generated

{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

401

Authorization not provided

Media typeapplication/json

object

message

required

string

code

required

string

issues

Array<object>

object

message

required

string

Example^generated

{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

403

Insufficient access

Media typeapplication/json

object

message

required

string

code

required

string

issues

Array<object>

object

message

required

string

Example^generated

{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

404

Not found

Media typeapplication/json

object

message

required

string

code

required

string

issues

Array<object>

object

message

required

string

Example^generated

{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

500

Internal server error

Media typeapplication/json

object

message

required

string

code

required

string

issues

Array<object>

object

message

required

string

Example^generated

{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}