Audit log
1 operation.
GET
/v1/audit-log
List the account's audit log, newest first.
- Operation id
listAuditLog- Who can call it
- Acts in one account, the one the credential belongs to.
- Credentials
- session or API key
- Permission
-
audit.read - Assistant tool
- No. Not in the first set of tools (decision 0043, point 9).
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
action
|
query | string | no | |
actor_type
|
query | string | no | |
actor_id
|
query | string | no | |
target_type
|
query | string | no | |
target_id
|
query | string | no | |
cursor
|
query | string | no | |
limit
|
query | string | no |
Answers
200 One page of audit entries. application/json
| Field | Type | Always sent | Notes |
|---|---|---|---|
entries
|
array of object | yes | |
entries[]
|
object | yes | |
entries[].id
|
string | yes | |
entries[].at
|
string | yes | Limits: format date-time. |
entries[].action
|
string | yes |
Values:
account.created
,
account.updated
,
member.added
,
member.role_changed
,
member.removed
,
invite.created
,
invite.resent
,
invite.revoked
,
invite.accepted
,
api_key.created
,
api_key.revoked
,
link_token.created
,
link_token.revoked
,
host.created
,
host.updated
,
host.active_set
,
host.archived
,
host.restored
,
host.time_off_added
,
host.time_off_removed
,
host.limits_replaced
,
host.external_id_set
,
host.external_id_removed
,
schedule.created
,
schedule.updated
,
schedule.rules_replaced
,
schedule.override_set
,
schedule.override_cleared
,
schedule.default_set
,
schedule.removed
,
calendar.connected
,
calendar.disconnected
,
calendar.selection_set
,
event_type.created
,
event_type.updated
,
event_type.active_set
,
event_type.archived
,
event_type.restored
,
event_type.hosts_set
,
event_type.questions_replaced
,
event_type.locations_replaced
,
event_type.host_groups_set
,
event_type.pauses_set
,
event_type.limits_replaced
,
host_group.created
,
host_group.updated
,
host_group.deleted
,
brand.created
,
brand.updated
,
brand.deleted
,
routing_form.created
,
routing_form.updated
,
routing_form.active_set
,
routing_form.archived
,
routing_form.restored
,
routing_form.questions_replaced
,
routing_form.rules_replaced
,
link.created
,
link.renamed
,
link.active_set
,
link.inactive_redirect_set
,
link.duplicate_rule_set
,
link.removed
,
bookings.exported
,
webhook_endpoint.created
,
webhook_endpoint.updated
,
webhook_endpoint.secret_rotated
,
webhook_endpoint.deleted
,
webhook_endpoint.tested
,
webhook_endpoint.switched_off
,
webhook_delivery.replayed
,
webhook_delivery.skipped
,
lookup_endpoint.created
,
lookup_endpoint.updated
,
lookup_endpoint.secret_rotated
,
lookup_endpoint.deleted
,
lookup_endpoint.tested
,
lookup_endpoint.switched_off
,
retention.swept
,
assistant_grant.created
,
assistant_grant.revoked
,
assistant_approval.requested
,
assistant_approval.decided
,
assistant_approval.used
,
support.access
,
account.suspended
,
account.unsuspended
,
page_report.closed
,
account.exported
,
account.deletion_requested
,
account.deletion_canceled
,
account.handle_rename_allowed
,
account.purge_started
,
visitor_data.exported
,
visitor_data.erased
.
|
entries[].target
|
object | yes | |
entries[].target.type
|
string | yes | |
entries[].target.id
|
string | yes | |
entries[].actor
|
object | yes | |
entries[].actor.type
|
string | yes |
Values:
member
,
api_key
,
system
,
support
.
|
entries[].actor.id
|
string | no | |
entries[].details
|
any | yes | |
next_cursor
|
string or null | yes |
Refusals
| Status | Meaning | Codes |
|---|---|---|
| 400 | The request is not valid. |
invalid_request
|
| 401 | Sign in is required. |
unauthenticated
|
| 403 | You are not allowed to do that. Choose an account to act in first. |
forbidden
,
no_active_account
|
| 429 | Too many attempts. |
rate_limited
|