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

from
string<date-time>

The start date and time of the audit log query range (UTC).

to
string<date-time>

The end date and time of the audit log query range (UTC).

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

18 - TransferPearl

19 - DeletePearl

30 - CreateAPIKey

31 - DeleteAPIKey

32 - RevealAPIKey

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

140 - GroupRetention

141 - DeleteContacts

userId
string | null

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

Response

The list of audit log.

timestamp
string<date-time>
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

18 - TransferPearl

19 - DeletePearl

30 - CreateAPIKey

31 - DeleteAPIKey

32 - RevealAPIKey

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

140 - GroupRetention

141 - DeleteContacts

user
object | null
additionalData
object | null