Retrieve Audit Log

GET 
/v1/audit_logs/:id

Retrieve a single audit log entry by its UUID. For active entries, metadata.subject_changes carries the before / after values of the changed attributes (sensitive fields filtered).

Required permission: audit_logs_read.

Request

Path Parameters

id uuidrequired

Audit log UUID.

Responses

200

The audit log entry.

application/json

Schema

Schema

id uuidrequired

A 36-character UUIDv7 identifier.

performer_type string

Possible values: [AcquirerUser, MerchantUser, StaffUser, ApiKey, AcquirerApiKey]

performer

object

nullable

Brief view of the acting user / API key (id, email when applicable).

id uuid

A 36-character UUIDv7 identifier.

email stringnullable
organization_type stringnullable

Possible values: [Acquirer, Merchant, null]

organization

object

nullable

Brief view of the owning organization.

id uuid

A 36-character UUIDv7 identifier.

name string

merchant_id stringnullable
subject_type stringnullable

Model name of the resource acted upon.

subject_id uuid

A 36-character UUIDv7 identifier.

login_session_id uuid

A 36-character UUIDv7 identifier.

action stringrequired

Controller action name.

action_type stringrequired

Possible values: [active, passive]

description string
metadata object

Request context — request_path, request_payload, user_agent, ip_info, and for active entries subject_changes (before / after values, sensitive fields filtered).

created_at date-timerequired

ISO 8601 UTC timestamp with time zone designator.

Example (from schema)

{
  "id": "0191f5a7-3d99-7f81-b7ec-962a5f5fdd7c",
  "performer_type": "AcquirerUser",
  "performer": {
    "id": "0191f5a7-3d99-7f81-b7ec-962a5f5fdd7c",
    "email": "string"
  },
  "organization_type": "Acquirer",
  "organization": {
    "id": "0191f5a7-3d99-7f81-b7ec-962a5f5fdd7c",
    "name": "string",
    "merchant_id": "string"
  },
  "subject_type": "Order",
  "subject_id": "0191f5a7-3d99-7f81-b7ec-962a5f5fdd7c",
  "login_session_id": "0191f5a7-3d99-7f81-b7ec-962a5f5fdd7c",
  "action": "create",
  "action_type": "active",
  "description": "AcquirerApiKey:0191… performed create action on Merchant:0192…",
  "metadata": {},
  "created_at": "2025-01-15T14:30:00Z"
}

401

Authentication failed.

application/json

Schema

Schema

message stringrequired

Example (from schema)

{
  "message": "Missing authentication information"
}

403

The API key lacks the required permission.

application/json

Schema

Schema

message stringrequired

Example (from schema)

{
  "message": "Unauthorized"
}

404

The referenced resource does not exist or belongs to another acquirer.

application/json

Schema

Schema

message stringrequired

Example (from schema)

{
  "message": "The Order you are looking for was not found."
}

Loading...