Retrieve Audit Event

Beta

GET/v1/core/audit-events/{id}

This endpoint is idempotent. Learn more

Returns an audit event by ID.

Permissions requiredValues:audit_events:read

The role behind your API key or agent must grant every one of these permissions.

idstring

Audit event ID.

include[]optional arrayenumValues:accountactorchanges

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

idstring

Audit event ID.

objectstringenumValues:audit_event

Resource type identifier.

actionstringenumValues:createupdatedelete

The type of action this event records.

create: the resource was created.
update: one or more fields were changed.
delete: the resource was deleted.
restore: a previously deleted resource was restored.
archive: the resource was archived.
approve: a human approved a gated action, such as allowing a review-gated agent tool to run.
deny: a human denied a gated action, such as rejecting a review-gated agent tool.

resource_typestringenumValues:accountactorentity

Resource type of the audited entity.

resource_idstring

Audited resource ID.

actoractorExpandablenullable

Actor who performed the mutation.

idstring

Unique identifier of the actor.

objectstringenumValues:actor

Resource type identifier.

typestringenumValues:userapi_keyagent

Actor type.

user: a human user account.
api_key: a programmatic caller authenticating with an API key.
agent: an automated agent acting on the account's behalf.
group: a shared group identity, such as a "Customer Service" persona, rather than a single individual.

namestringnullable

The actor's display name.

handlestringnullable

Human-readable handle identifying the actor.

For user actors: the user's email address.
For api_key actors: the redacted key value.

Other actor types carry no handle.

avatar_urlstringnullable

URL of the actor's profile photo, if one is set.

Only populated for user actors.

rolerolenullable

Assigned role.

Always returned as null in this endpoint.

accountaccountExpandablenullable

Account the audited mutation was performed against.

For a mutation on one of your own resources this is your account; when you act on a customer's or supplier's account, it is that account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

Default billing address.

Always returned as null in this endpoint.

default_shipping_addressaddressnullable

Default shipping address.

Always returned as null in this endpoint.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

Always returned as null in this endpoint.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

changeslistExpandablenullable

Field-level changes recorded for this event.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of audit_field_change

Resources in this page.

objectstringenumValues:audit_field_change

Resource type identifier.

fieldstring

Name of the changed field.

old_valueobjectnullable

Previous value as a JSON fragment.

null for creation events.

Encoded as a JSON value (object, array, string, number, boolean, or null), not a JSON-encoded string.

new_valueobjectnullable

New value as a JSON fragment.

null for deletion events.

Encoded as a JSON value (object, array, string, number, boolean, or null), not a JSON-encoded string.

metadataobjectExpandablenullable

Arbitrary JSON metadata for the mutation (e.g. reason, source, tags).

Encoded as a JSON value (object, array, string, number, boolean, or null), not a JSON-encoded string.

requestrequest_logExpandablenullable

Log of the API request that caused the mutation.

null when the change did not originate from an API request.

idstring

Request log ID.

objectstringenumValues:request_log

Resource type identifier.

methodstring

HTTP method.

hoststring

Request host.

Usually api.augno.com.

pathstring

The exact path the request was made to, including path parameter values.

normalized_routestring

The route template the request matched, with path parameters left as placeholders.

For example /v1/sales/customers/{id} is the normalized route for the request path /v1/sales/customers/ac_.... Falls back to the raw path when the request did not match a registered route.

query_paramsobjectnullable

Query parameters.

Encoded as a JSON value (object, array, string, number, boolean, or null), not a JSON-encoded string.

status_codeinteger

HTTP response status code (e.g. 200, 404).

latency_usinteger

Request latency in microseconds.

api_versionstringnullable

API version used.

client_ipstringnullable

Client IP address.

user_agentstringnullable

User agent.

referrerstringnullable

Referrer header.

error_codestringnullable

Machine-readable API error code.

Populated only for failed requests.

error_messagestringnullable

Human-readable error message.

Populated only for failed requests.

occurred_atstring (date-time)

When the request occurred.

created_atstring (date-time)

When the log entry was created.

accountaccountExpandablenullable

Account targeted by the request: the account the request acted upon.

Results are scoped to logs where your account is either the acting account or the target account. Use the target_account_ids query parameter to filter by which account was acted upon, and actor_account_ids to filter by who acted.

Always returned as null in this endpoint.

actoractorExpandablenullable

Actor who made the request.

Always returned as null in this endpoint.

idempotency_keystringnullable

User-provided idempotency key.

request_bodyobjectnullable

Request body.

Encoded as a JSON value (object, array, string, number, boolean, or null), not a JSON-encoded string.

response_bodyobjectnullable

Response body.

Encoded as a JSON value (object, array, string, number, boolean, or null), not a JSON-encoded string.

idempotency_keystringnullable

Idempotency key of the originating request.

source_ipstringnullable

Originating client IP address.

occurred_atstring (date-time)

When the audited mutation occurred.

created_atstring (date-time)

When the audit event record was created.

Responses

200

Successful response for Retrieve Audit Event

Retrieve Audit Event

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const auditEvent = await client.core.auditEvents.retrieve('ae_01b1c07dc3085bbd84111edcbd');

console.log(auditEvent.id);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const auditEvent = await client.core.auditEvents.retrieve('ae_01b1c07dc3085bbd84111edcbd');

console.log(auditEvent.id);

200 example

{
  "id": "ae_01b1c07dc3085bbd84111edcbd",
  "object": "audit_event",
  "action": "update",
  "resource_type": "user",
  "resource_id": "us_0151164dcaea4cbded27b50aae",
  "actor": {
    "id": "us_0151164dcaea4cbded27b50aae",
    "object": "actor",
    "type": "user",
    "name": "John Doe",
    "handle": "jdoe@augno.com",
    "avatar_url": "https://cdn.augno.com/avatars/us_0151164dcaea4cbded27b50aae.jpg",
    "role": null
  },
  "account": {
    "id": "ac_01148680966698341a9c0976db",
    "object": "account",
    "name": "Acme Inc.",
    "default_billing_address": null,
    "default_shipping_address": null,
    "branding": null,
    "portal": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "changes": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "object": "audit_field_change",
        "field": "email",
        "old_value": "old@example.com",
        "new_value": "new@example.com"
      }
    ]
  },
  "metadata": {
    "reason": "operator override"
  },
  "request": {
    "id": "rq_01304bffe90e8cce9690cbefd4",
    "object": "request_log",
    "method": "GET",
    "host": "https://api.augno.com",
    "path": "/v1/core/sandboxes",
    "normalized_route": "/v1/core/sandboxes",
    "query_params": null,
    "status_code": 200,
    "latency_us": 12345,
    "api_version": "2026-01-01",
    "client_ip": "198.51.100.7",
    "user_agent": "Mozilla/5.0",
    "referrer": null,
    "error_code": null,
    "error_message": null,
    "occurred_at": "2026-05-10T00:00:00Z",
    "created_at": "2026-05-10T00:00:00Z",
    "account": null,
    "actor": null,
    "idempotency_key": null,
    "request_body": null,
    "response_body": null
  },
  "idempotency_key": null,
  "source_ip": "198.51.100.8",
  "occurred_at": "2026-05-10T00:00:00Z",
  "created_at": "2026-05-10T00:00:00Z"
}

{
  "id": "ae_01b1c07dc3085bbd84111edcbd",
  "object": "audit_event",
  "action": "update",
  "resource_type": "user",
  "resource_id": "us_0151164dcaea4cbded27b50aae",
  "actor": {
    "id": "us_0151164dcaea4cbded27b50aae",
    "object": "actor",
    "type": "user",
    "name": "John Doe",
    "handle": "jdoe@augno.com",
    "avatar_url": "https://cdn.augno.com/avatars/us_0151164dcaea4cbded27b50aae.jpg",
    "role": null
  },
  "account": {
    "id": "ac_01148680966698341a9c0976db",
    "object": "account",
    "name": "Acme Inc.",
    "default_billing_address": null,
    "default_shipping_address": null,
    "branding": null,
    "portal": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "changes": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "object": "audit_field_change",
        "field": "email",
        "old_value": "old@example.com",
        "new_value": "new@example.com"
      }
    ]
  },
  "metadata": {
    "reason": "operator override"
  },
  "request": {
    "id": "rq_01304bffe90e8cce9690cbefd4",
    "object": "request_log",
    "method": "GET",
    "host": "https://api.augno.com",
    "path": "/v1/core/sandboxes",
    "normalized_route": "/v1/core/sandboxes",
    "query_params": null,
    "status_code": 200,
    "latency_us": 12345,
    "api_version": "2026-01-01",
    "client_ip": "198.51.100.7",
    "user_agent": "Mozilla/5.0",
    "referrer": null,
    "error_code": null,
    "error_message": null,
    "occurred_at": "2026-05-10T00:00:00Z",
    "created_at": "2026-05-10T00:00:00Z",
    "account": null,
    "actor": null,
    "idempotency_key": null,
    "request_body": null,
    "response_body": null
  },
  "idempotency_key": null,
  "source_ip": "198.51.100.8",
  "occurred_at": "2026-05-10T00:00:00Z",
  "created_at": "2026-05-10T00:00:00Z"
}

Retrieve Audit Event

Authorization

Path Parameters

Query Parameters

Returns

Responses