List audit logs

GET

https://localhost:8080/api/v1/audit-logs

GET

/api/v1/audit-logs

1 curl -G https:https://localhost:8080/api/v1/audit-logs \
2      -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.exampletoken1234567890" \
3      -H "X-Workspace-Id: a3f1c9d2-4b7e-4f8a-9c3d-2e5f7b1a9d6c" \
4      -H "Content-Type: application/json" \
5      -d cursor=eyJjdXJzb3IiOiIxMjM0NTY3ODkwIn0 \
6      -d limit=50

1 {
2   "data": [
3     {
4       "id": "b7f3a1d4-9c2e-4f5a-8b6d-3e7f9a2c1d0e",
5       "timestamp": "2024-06-10T15:22:30Z",
6       "userId": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a",
7       "action": "user.login",
8       "details": {
9         "ipAddress": "192.168.1.100",
10         "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 Chrome/113.0.0.0 Safari/537.36"
11       },
12       "success": true
13     },
14     {
15       "id": "c8d9e0f1-2a3b-4c5d-6e7f-8091a2b3c4d5",
16       "timestamp": "2024-06-10T14:58:12Z",
17       "userId": "a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d",
18       "action": "workspace.update",
19       "details": {
20         "changedFields": [
21           "name",
22           "billingPlan"
23         ],
24         "previousValues": {
25           "name": "Old Workspace Name",
26           "billingPlan": "team"
27         },
28         "newValues": {
29           "name": "New Workspace Name",
30           "billingPlan": "enterprise"
31         }
32       },
33       "success": true
34     }
35   ],
36   "meta": {
37     "nextCursor": "eyJjdXJzb3IiOiI0NTY3ODkwMTIzIn0=",
38     "limit": 50,
39     "hasMore": true
40   }
41 }

Cursor-paginated audit logs. Team/Enterprise/Contact tier. owner/admin/viewer.

Query parameters

cursorstringOptional

Cursor

limitintegerOptional

Limit (default 20, max 200)

Response

data: AuditLogEntry[], meta: CursorMeta

Errors

403

Forbidden Error

Headers

Query parameters

Response

Errors