Skip to main content

List Logs (v1)

Get system audit logs with filtering.

Method & Path

GET /v1/admin/logs

Description

Retrieves a paginated list of system audit logs with optional filtering by actor, target, and action.

Authentication

Required: Admin authentication with audit.logs.view permission.

Query Parameters

ParameterTypeRequiredDescription
pagenumberNoPage number
limitnumberNoItems per page (max: 100)
actorIdstringNoFilter by actor admin ID
actorEmailstringNoFilter by actor email
targetTypeenumNoFilter by target resource type
targetIdstringNoFilter by target resource ID
actionenumNoFilter by action type

Response 200 OK

{
"logs": [
{
"id": "507f1f77bcf86cd799439011",
"actorId": "507f1f77bcf86cd799439012",
"actorEmail": "admin@example.com",
"action": "create",
"targetType": "workspace",
"targetId": "507f1f77bcf86cd799439013",
"createdAt": "2024-01-15T10:00:00Z"
}
],
"meta": {
"pagination": {
"page": 1,
"limit": 20,
"total": 100
},
"resourceTypes": ["workspace", "admin", "plan"],
"actions": ["create", "update", "delete"]
}
}

Common Errors

  • 401 Unauthorized: Missing or invalid admin authentication token
  • 403 Forbidden: Insufficient permissions
  • 400 Bad Request: Invalid query parameters
  • 500 Internal Server Error: Server error