Get an identity audit event with related events

GET

/api/v1/audit-events/{id}

Returns a single identity-surface audit event by id, plus two related-event sidecars: related_by_correlation (other rows sharing this row's correlation_id) and related_by_actor (the same actor's recent events). The lookup is pinned to the principal's bound Application and Environment, so an env-pinned key cannot fetch rows from outside its Environment. Reading a row writes one audit.row.viewed audit entry. Returns 404 for a missing row, an admin-only row, or a row outside the bound surface/Environment — the cases are indistinguishable on the wire to avoid leaking row ids.

Authentication

Bearer TokenAuthorization Option A

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Path Parameters

idstring Required

Responses

application/json

dataAuditLogDetailResponseDto*

application/json

errorApiErrorBodyDto*

application/json

errorApiErrorBodyDto*

application/json

errorApiErrorBodyDto*

Returned object

AuditLogDetailResponseDtoView all properties on this resource

Request

curl -X GET "https://auth.canopy-io.com/api/v1/audit-events/value" \
  -H "X-API-Key: $CANOPY_API_KEY"

Response

{
  "data": {
    "id": "string",
    "account_id": "string",
    "application_id": "string",
    "environment_id": "string",
    "actor_id": "string",
    "actor_type": "string",
    "action": "string",
    "resource_type": "string",
    "resource_id": "string",
    "metadata": {},
    "created_at": "2026-04-20T12:00:00.000Z",
    "actor_label": "string",
    "resource_label": "string",
    "correlation_id": "00000000-0000-0000-0000-000000000000",
    "outcome": "success",
    "category": "auth",
    "severity": "info",
    "customer_visible": false,
    "identity_visible": false,
    "related_by_correlation": [
      {
        "id": "string",
        "account_id": "string",
        "application_id": "string",
        "environment_id": "string",
        "actor_id": "string",
        "actor_type": "string",
        "action": "string",
        "resource_type": "string",
        "resource_id": "string",
        "metadata": {},
        "created_at": "2026-04-20T12:00:00.000Z",
        "actor_label": "string",
        "resource_label": "string",
        "correlation_id": "00000000-0000-0000-0000-000000000000",
        "outcome": "success",
        "category": "auth",
        "severity": "info",
        "customer_visible": false,
        "identity_visible": false
      }
    ],
    "related_by_actor": [
      {
        "id": "string",
        "account_id": "string",
        "application_id": "string",
        "environment_id": "string",
        "actor_id": "string",
        "actor_type": "string",
        "action": "string",
        "resource_type": "string",
        "resource_id": "string",
        "metadata": {},
        "created_at": "2026-04-20T12:00:00.000Z",
        "actor_label": "string",
        "resource_label": "string",
        "correlation_id": "00000000-0000-0000-0000-000000000000",
        "outcome": "success",
        "category": "auth",
        "severity": "info",
        "customer_visible": false,
        "identity_visible": false
      }
    ]
  }
}

GETQuery identity audit events
GETList recent audit-log export jobs
POSTCreate an identity audit-events export job (CSV / NDJSON)
GETGet an audit-log export job
DELETEDelete an audit-log export job

Was this page helpful?

Tell us how we can improve this guide.