API for accessing recorded organization administrative actions. Operators must verify event coverage, retention, access controls, and export behavior for the release they deploy. Audit records can support security, governance, and compliance programs but do not establish them by themselves.
Overview
Organization audit logs expose implemented administrative event records for:
- Compliance evidence input: Supply selected records to an operator-defined control program
- Security: Detect and investigate suspicious activities
- Governance: Monitor who did what and when
- Debugging: Troubleshoot configuration changes and issues
- Accountability: Maintain transparency in team operations
Each audit log entry includes:
- Actor: User who performed the action
- Action: Type of event (e.g.,
service.created,user.invited) - Target: Resource affected (e.g., service, user, organization)
- Timestamp: When the action occurred
- Metadata: Additional context (JSON)
- Success: Whether the action succeeded
- IP Address: Client IP (if available)
- User Agent: Client browser/tool (if available)
Endpoints Summary
| Method | Path | Description | Permissions |
|---|---|---|---|
| GET | /api/organizations/:org_slug/audit-log |
Get audit logs | Owner/Admin |
| GET | /api/organizations/:org_slug/audit-log/event-types |
Get available event types | Owner/Admin |
Choose an audit-log task
| Need | Focused reference |
|---|---|
| Inspect response models, event types, and endpoint contracts | Endpoint reference |
| Investigate activity and filter by action or target | Querying and filtering |
| Export records or connect external monitoring | Export and integrations |
| Define retention, access, evidence, and review controls | Compliance and security |
| Diagnose access, pagination, coverage, or context gaps | Troubleshooting |
Audit records are evidence inputs, not a certification or an immutable ledger. Validate event coverage, retention, redaction, and exports against the release and control program you operate.
Published-anchor compatibility
This overview remains the stable published route. The headings below retain the original fragment identifiers and direct existing links to focused references.
Data Models
Continue in the endpoint reference.
Audit Log Entry
Continue in the endpoint reference.
Audit Log Response with User
Continue in the endpoint reference.
Pagination Info
Continue in the endpoint reference.
Audit Event Types
Continue in the endpoint reference.
User Management Events
Continue in the endpoint reference.
Service Management Events
Continue in the endpoint reference.
Organization Management Events
Continue in the endpoint reference.
Plan Management Events
Continue in the endpoint reference.
Subscription Management Events
Continue in the endpoint reference.
Invitation Management Events
Continue in the endpoint reference.
Security Events
Continue in the endpoint reference.
API Key Management Events
Continue in the endpoint reference.
Custom Domains & Branding Events
Continue in the endpoint reference.
Audit Log Operations
Continue in the endpoint reference.
GET /api/organizations/:org_slug/audit-log
Continue in the endpoint reference.
GET /api/organizations/:org_slug/audit-log/event-types
Continue in the endpoint reference.
Common Use Cases
Continue in querying and filtering.
Security Investigation
Continue in querying and filtering.
Configuration Change Tracking
Continue in querying and filtering.
User Activity Report
Continue in querying and filtering.
Compliance Evidence Export
Continue in export and integrations.
Security Considerations
Continue in compliance and security.
Integration Examples
Continue in export and integrations.
Export to Splunk
Continue in export and integrations.
Slack Notifications
Continue in export and integrations.
Python Report Generator
Continue in export and integrations.