Audit events

Read recorded organization changes, including other members\u2019 actions. API reads do not each create an audit event.

GET /v1/org/audit-events

Authorization

Authorizationheader · string

Bearer $BOARDWALK_API_KEY. Requires audit:read.

Request

curl "https://api.boardwalk.cloud/v1/org/audit-events?limit=50" \
  -H "Authorization: Bearer $BOARDWALK_API_KEY"

Query parameters

cursorstringoptional

Opaque next_cursor from the previous page, at most 256 characters. Keep all other filters unchanged.

limitintegeroptional

Page size from 1 to 200. Default: 50.

actor_user_idstringoptional

Filter by acting user.

resource_typestringoptional

org, membership, invitation, api_key, billing, or model_config.

fromintegeroptional

Inclusive start time in epoch milliseconds.

tointegeroptional

Exclusive end time in epoch milliseconds. Must be later than from.

Response

Example response. IDs, token counts, and rates are illustrative.

{
  "object": "list",
  "data": [
    {
      "id": "evt_example",
      "object": "audit_event",
      "actor_kind": "user",
      "actor_user_id": "user_example",
      "resource_type": "api_key",
      "resource_id": "key_example",
      "action": "created",
      "before": null,
      "after": { "name": "Production" },
      "created_at": "2026-09-16T00:00:00.000Z"
    }
  ],
  "next_cursor": null
}

object"list"

Object type.

dataobject[]

Records ordered newest first.

Child fields

idstring

Event ID.

object"audit_event"

Object type.

actor_kindstring

user, system, webhook, or admin.

actor_user_idstring | null

Acting user, when applicable.

resource_typestring

org, membership, invitation, api_key, billing, or model_config.

resource_idstring

Affected resource ID.

actionstring

Recorded action: created, updated, activated, deleted, revoked, invited, joined, role_changed, removed, resumed, or granted.

beforeJSON

Redacted state before the change.

afterJSON

Redacted state after the change.

created_atstring

ISO 8601 event timestamp.

next_cursorstring | null

Pass as cursor for the next page. Null marks the end.

Retrieve one record

GET /v1/org/audit-events/{id} returns one object directly, without the list envelope. It accepts no query parameters.

idpath · stringrequired

Record ID from a list response.

curl https://api.boardwalk.cloud/v1/org/audit-events/evt_example \
  -H "Authorization: Bearer $BOARDWALK_API_KEY"

{
  "id": "evt_example",
  "object": "audit_event",
  "actor_kind": "user",
  "actor_user_id": "user_example",
  "resource_type": "api_key",
  "resource_id": "key_example",
  "action": "created",
  "before": null,
  "after": { "name": "Production" },
  "created_at": "2026-09-16T00:00:00.000Z"
}

Detail fields match the object in data above.

Errors

Errors use the shared error format. Save the x-request-id response header for receipts and support.