GET/api/organizations/{organization_id}/audit-logAuthenticated

List an organization's audit log

Lists the organization's recorded events, newest first: invitations sent, revoked, accepted and declined, members added and removed, role changes, and changes to its MFA requirement, each with who did it and who it was about. Paginated with cursor. Only organization owners and platform administrators may call it. Entries never carry ip_address or user_agent. An organization created with the id of a deleted one does not see its predecessor's events.

operationId get_api_organizations_organization_id_audit_logOrganizations

Authentication & permissionsAuthenticated

Any authenticated user

Accepted credentials
Who may call
Any authenticated user
Notes
Only organization owners or platform administrators may read the audit log.

Path parameters

NameTypeDescription
organization_id*string

Organization id (URL-safe slug)

Query parameters

NameTypeDescription
limitinteger

Page size (default 25, at most 100).

cursorstring

next_cursor of the previous page: lists the events older than that page.

event_type"user.registered" | "user.signed_in" | "user.sign_in_failed" | "user.mfa_challenge_failed" | "user.signed_out" | "user.password_reset" | "user.email_verified" | "user.profile_updated" | "user.mfa_factor_added" | "user.mfa_factor_removed" | "user.mfa_recovery_codes_regenerated" | "user.mfa_reset_by_admin" | "user.app_authorized" | "user.app_authorization_revoked" | "user.app_scope_consent_revoked" | "user.device_authorized" | "user.device_authorization_denied" | "user.disabled" | "user.enabled" | "user.promoted_to_admin" | "organization.created" | "organization.deleted" | "organization.invitation_sent" | "organization.invitation_revoked" | "organization.invitation_accepted" | "organization.invitation_declined" | "organization.member_added" | "organization.member_role_changed" | "organization.member_removed" | "organization.mfa_requirement_enabled" | "organization.mfa_requirement_updated" | "organization.mfa_requirement_disabled"

Only list events of this type.

Responses

application/json
ListAuditLogResponse
PropertyTypeDescription
success*true
data*object
entries*AuditLogEntry[]
audit_event_id*string
created_at*number
event_type*"user.registered" | "user.signed_in" | "user.sign_in_failed" | "user.mfa_challenge_failed" | "user.signed_out" | "user.password_reset" | "user.email_verified" | "user.profile_updated" | "user.mfa_factor_added" | "user.mfa_factor_removed" | "user.mfa_recovery_codes_regenerated" | "user.mfa_reset_by_admin" | "user.app_authorized" | "user.app_authorization_revoked" | "user.app_scope_consent_revoked" | "user.device_authorized" | "user.device_authorization_denied" | "user.disabled" | "user.enabled" | "user.promoted_to_admin" | "organization.created" | "organization.deleted" | "organization.invitation_sent" | "organization.invitation_revoked" | "organization.invitation_accepted" | "organization.invitation_declined" | "organization.member_added" | "organization.member_role_changed" | "organization.member_removed" | "organization.mfa_requirement_enabled" | "organization.mfa_requirement_updated" | "organization.mfa_requirement_disabled"
actor*object | null | null
uid*string | null | null
email*string | null | null
subject*object | null | null
uid*string | null | null
email*string | null | null
organization_id*string | null | null
client_app_id*string | null | null
ip_address*string | null | null
user_agent*string | null | null
details*object | null | null
next_cursor*string | null | null

Pass as cursor to get the next (older) page; null on the last page.

JSONExample
"success"true
"data"
"entries"
"next_cursor""string"

Example request

bashcurl
curl -X GET 'https://auth.botreeinc.com/api/organizations/<organization_id>/audit-log' \
  -b 'refresh_token_<auth_server_app_id>=<value>'