Skip to Content
GET
/api/v1/accounts/{accountId}/audit

Returns a paginated list of security and directory audit events for an account. Events older than 180 days are excluded. An account keeps at most its newest 1,000,000 events: past that, the oldest are pruned as new ones are written, so a high-churn account's trail can be shorter than 180 days.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Two credential kinds share this scheme; GET /api/v1/auth/whoami answers which one you hold and what it reaches.

oek_… API key (minted by POST /api/v1/api-keys; shown once at mint). role: account reaches the full account surface: the directory (domains, routes, patterns, api-keys, accounts, address lists) plus every mailbox the account owns. role: system additionally reaches the operator surface, which is documented separately.

oemp_… mailbox app password (minted by POST /api/v1/identities/{identityId}/credentials). Reaches ONE mailbox: its messages, labels, threads, search, sync, send, filters and PIM collections. Directory routes refuse it with 403 insufficient_scope.

Refusal vocabulary: a missing, malformed, expired, or revoked credential answers 401 unauthorized with a WWW-Authenticate: Bearer challenge; a VALID credential outside its scope answers 403 (insufficient_scope for an app password on a directory route, system_credentials_required where only the operator may call). The public routes (health, branding, token-in-path capabilities) declare security: [].

Path Parameters

accountId*string

Account ULID identifier

Query Parameters

resourceType?string

Exact resource type, e.g. mailbox

Lengthlength <= 64
resourceId?string

Exact resource id — one object's history

Lengthlength <= 255
action?string

Exact action, e.g. domain.update

Lengthlength <= 128
limit?integer

Page size (default 100)

Range1 <= value <= 200
cursor?string

Opaque page cursor from a previous response

Response Body

Page of audit events

application/json
  1. response
events*array<>
nextCursor?string

Opaque cursor for the next page; absent on the last page

Example Request
curl -X GET 'https://api.open.email/api/v1/accounts/string/audit'
Example Response
{
  "events": [
    {
      "accountId": "string",
      "action": "string",
      "actorId": "string",
      "actorName": "string",
      "actorType": "system",
      "createdAt": 0,
      "detail": {
        "property1": null,
        "property2": null
      },
      "forwardedIp": "string",
      "id": "string",
      "ip": "string",
      "mailboxId": "string",
      "resourceId": "string",
      "resourceType": "string"
    }
  ],
  "nextCursor": "string"
}