API reference

Audit

1 endpoint, served at https://orbitwrite.com/api/v1. Each one lists the credentials it accepts, its parameters and every response it can give.

Endpoints

GET/api/v1/audit-log

List a workspace's audit trail#

GET/api/v1/audit-log

Newest-first audit entries with actor details. Owner/admin only — the trail includes member management and key/secret lifecycle events.

Authentication

A signed-in session only. The Orbitwrite app calls this; an API key is refused.

Query parameters

organizationIdstringRequired: At least 1 character.
limitinteger: Between 1 and 100. Defaults to 50.
offsetinteger | null: At least 0. Defaults to 0.

Responses

200AuditLog

The audit entries

Response attributes

entriesAuditEntry[]Required

Child attributes

idstringRequired
actionstringRequired
targetTypestring | nullRequired
targetIdstring | nullRequired
metadatastring | nullRequired: JSON-encoded event details, shape varies per action
ipAddressstring | nullRequired
createdAtstringRequired: ISO 8601.
actorNamestringRequired
actorEmailstringRequired
actorImagestring | nullRequired

400Error

Invalid request

Response attributes

errorstringRequired
issuesany[]

401Error

Not signed in

Response attributes

errorstringRequired
issuesany[]

403Error

Not a member of the organization

Response attributes

errorstringRequired
issuesany[]

GET /api/v1/audit-log

curl -X GET "https://orbitwrite.com/api/v1/audit-log?organizationId=organizationId" \
  -H "Authorization: Bearer $ORBITWRITE_API_KEY"

Response

{
  "entries": [
    {
      "id": "string",
      "action": "string",
      "targetType": "string",
      "targetId": "string",
      "metadata": "string",
      "ipAddress": "string",
      "createdAt": "string",
      "actorName": "string",
      "actorEmail": "string",
      "actorImage": "string"
    }
  ]
}