Get an identity audit event with related events

GET

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

Authentication

Bearer Token Authorization
JWT access token
API Key X-API-Key
API key for management-tier access

Path Parameters

Name	Required	Type	Description
`id`	Required	`string`

Code samples

cURL

JavaScript

Python

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

const response = await fetch("https://api.canopy.dev/api/v1/audit-events/value", {
  method: "GET",
  headers: {
    "X-API-Key": "$CANOPY_API_KEY"
  },
});

const data = await response.json();

import requests

response = requests.get(
    "https://api.canopy.dev/api/v1/audit-events/value",
    headers={
    "X-API-Key": "$CANOPY_API_KEY"
    },
)

data = response.json()

package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.canopy.dev/api/v1/audit-events/value", nil)
	req.Header.Set("X-API-Key", "$CANOPY_API_KEY")

	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

200 Public-API single-row endpoint. Restricted to identity-surface rows; returns 404 for admin-only rows even when the row id is correct.

{
  "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
    }
  ]
}

application/json

idstring*
account_idstring
application_idstring
environment_idstring
actor_idstring
actor_typestring*
actionstring*
resource_typestring
resource_idstring
metadataany object*
created_atstring (date-time)*
actor_labelstring
Snapshot label of the actor at write time (email for users / identities, label otherwise). NULL on rows written before the Slice 2 deploy.
resource_labelstring
Snapshot label of the affected resource at write time. NULL on rows written before the Slice 2 deploy.
correlation_idstring (uuid)
Per-request correlation ID — every row written during the same HTTP request (or background job) shares this value. Use the query API's `correlation_id` filter to reconstruct a chain.
outcomeenum: "success" | "failure" | "denied"*
`success` for normal-flow events, `failure` for errors, `denied` for authorization rejections.
categoryenum: "auth" | "identity" | "admin_user" | "tenancy" | "hierarchy" | "rbac" | "authorization" | "api_keys" | "oauth" | "webhooks" | "invites" | "mfa" | "audit" | "billing" | "unknown"
Broad classification from the action catalog (e.g. `auth`, `rbac`). NULL on legacy rows whose action key was unknown at backfill time — those carry the `unknown` value in storage.
severityenum: "info" | "notice" | "warning" | "critical"*
`info` for normal-flow events, `notice` for important state changes, `warning` for failures, `critical` for security events.
customer_visibleboolean*
Whether this row should appear in customer-facing audit views. `false` rows are internal-only (platform support).
identity_visibleboolean*
Whether this row should appear on a future end-user `My security activity` surface. Not consumed by Phase 1 reads.
related_by_correlationAuditLogRowDto[]*
related_by_actorAuditLogRowDto[]*

401 Invalid or expired token

403 This token is not authorized for this endpoint (wrong principal type — e.g., admin token on identity-only endpoint, or vice versa)

404 Audit-log row not found. Indistinguishable from a row that exists but belongs to a different Account, a different surface, or is internal-only — disclosing the difference would leak the presence of cross-surface or platform-support rows.

Returned object

The AuditLogDetailResponseDto object View all properties on this resource

On this page