Skip to main content
POST
Get Audit Log

Authorizations

Authorization
string
header
required

Specify the authorization token.

For more information, check out the Authorization Guide.

Body

Represents the filters and pagination options used to retrieve the audit log of the account. By default, entries are sorted by Timestamp in ascending order (oldest first) and up to 100 entries are returned. SortProp accepts Timestamp, EventType or User (sorted by user name).

fromDate
string<date-time>
required

The start date for filtering the search results.

toDate
string<date-time>
required

The end date for filtering the search results.

skip
integer<int32>

Number of entries to skip for pagination.

limit
integer<int32>

Limit on the number of entries to return.

sortProp
string | null

Property name to sort by.

isAscending
boolean

Whether the sort order is ascending.

from
string<date-time>

The start date and time of the audit log query range (UTC). Alias of FromDate: send either one.

to
string<date-time>

The end date and time of the audit log query range (UTC). Alias of ToDate: send either one. The range cannot exceed 90 days.

eventType
integer<int32> | null

The type of event recorded in the audit log.

1 - LoginAttempt

2 - LoginSuccessful

10 - PublishPearl

11 - PearlStatus

12 - PearlRetention

13 - PearlTotalAgents

14 - PearlBudget

15 - PearlPhoneNumber

16 - CreatePearlVersion

17 - DeletePearlVersion

18 - TransferPearl

19 - DeletePearl

30 - CreateAPIKey

31 - DeleteAPIKey

32 - RevealAPIKey

33 - UpdateAPIKey

34 - RotateAPIKeySecret

40 - PurchaseAgents

41 - DeleteAgent

50 - SetBillingDetails

51 - SetPaymentMethod

52 - SetSubscription

59 - CancelSubscription

60 - PurchaseCredits

61 - SetAutoRecharge

70 - InviteUser

71 - UserJoin

72 - InvitationCanceled

73 - UpdateUserRole

74 - UpdateAccountInformations

75 - RemoveUserFromTheAccount

76 - UserLeftAccount

77 - CreateRole

78 - UpdateRole

79 - DeleteRole

80 - UpdateSessionTTL

81 - Set2FA

82 - ChangePassword

90 - DeleteAccount

91 - AddToBlacklist

92 - RemoveFromBlacklist

100 - PurchasePhoneNumbers

101 - ReleasePhoneNumber

102 - AddPhoneNumber

103 - UpdatePhoneNumber

104 - UpdateSIPConfig

105 - SetTwilioCredentials

110 - CreateTextChannel

111 - UpdateTextChannel

112 - DeleteTextChannel

113 - RotateChannelSecret

114 - RevealChannelSecret

115 - ConnectWhatsApp

116 - AddWhatsAppNumber

117 - DisconnectWhatsApp

120 - SetEmailCredentials

121 - DeleteEmailCredentials

122 - ConnectSlack

123 - ConnectCalendar

130 - ImportLeads

131 - DeleteLeads

132 - DeleteCalls

133 - ExportCalls

134 - RefreshLeads

140 - GroupRetention

141 - DeleteContacts

150 - CloneVoice

151 - DeleteVoice

152 - ShareVoice

160 - VibePearlSideEffectRun

userId
string | null

Optional filter by user ID. If not provided, logs for all users are returned.

isPaginate
boolean | null

Indicates whether the response is paginated. When true, the response is an object with the total count of matching entries and the current page of results. When false or omitted (default), the response is a flat list of audit log entries.

Response

The list of audit log entries (or a paginated result when IsPaginate is true).

timestamp
string<date-time>

The UTC timestamp of when the audit log event occurred.

eventType
integer<int32>

The type of event recorded in the audit log.

1 - LoginAttempt

2 - LoginSuccessful

10 - PublishPearl

11 - PearlStatus

12 - PearlRetention

13 - PearlTotalAgents

14 - PearlBudget

15 - PearlPhoneNumber

16 - CreatePearlVersion

17 - DeletePearlVersion

18 - TransferPearl

19 - DeletePearl

30 - CreateAPIKey

31 - DeleteAPIKey

32 - RevealAPIKey

33 - UpdateAPIKey

34 - RotateAPIKeySecret

40 - PurchaseAgents

41 - DeleteAgent

50 - SetBillingDetails

51 - SetPaymentMethod

52 - SetSubscription

59 - CancelSubscription

60 - PurchaseCredits

61 - SetAutoRecharge

70 - InviteUser

71 - UserJoin

72 - InvitationCanceled

73 - UpdateUserRole

74 - UpdateAccountInformations

75 - RemoveUserFromTheAccount

76 - UserLeftAccount

77 - CreateRole

78 - UpdateRole

79 - DeleteRole

80 - UpdateSessionTTL

81 - Set2FA

82 - ChangePassword

90 - DeleteAccount

91 - AddToBlacklist

92 - RemoveFromBlacklist

100 - PurchasePhoneNumbers

101 - ReleasePhoneNumber

102 - AddPhoneNumber

103 - UpdatePhoneNumber

104 - UpdateSIPConfig

105 - SetTwilioCredentials

110 - CreateTextChannel

111 - UpdateTextChannel

112 - DeleteTextChannel

113 - RotateChannelSecret

114 - RevealChannelSecret

115 - ConnectWhatsApp

116 - AddWhatsAppNumber

117 - DisconnectWhatsApp

120 - SetEmailCredentials

121 - DeleteEmailCredentials

122 - ConnectSlack

123 - ConnectCalendar

130 - ImportLeads

131 - DeleteLeads

132 - DeleteCalls

133 - ExportCalls

134 - RefreshLeads

140 - GroupRetention

141 - DeleteContacts

150 - CloneVoice

151 - DeleteVoice

152 - ShareVoice

160 - VibePearlSideEffectRun

user
object | null

Information about the user who triggered the event.

additionalData
object | null

Optional additional metadata associated with the event, as key-value pairs.