Skip to main content
GET
Get an audit event

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

UUID of the organization whose audit log to read.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
event_id
string<shortuuid>
required

Identifier of the audit event.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

OK

One entry of an organization's audit log.

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
display_name
string
required

Customer-facing label for the action, for example Update Product.

Example:

"Update Product"

status
enum<string>
required

Whether the action succeeded or failed.

Available options:
SUCCESS,
FAILURE
Example:

"SUCCESS"

created
string<date-time>
required

ISO-8601 UTC timestamp of when the action ran.

role
string
required

The acting member's role in the organization when the action ran; blank when unrecorded.

Example:

"manager"

credential_type
enum<string>
required

Kind of credential that performed the action: a browser session, an API key, an OAuth token and so on.

Available options:
session,
api_key,
oauth_application,
oauth_token,
internal,
unknown
Example:

"api_key"

api_key_id
string<shortuuid> | null

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
actor_email
string | null

Email of the member accountable for the action. For an API key this is the member who created the key, not necessarily who made the call. Null when the member has since been deleted.

Example:

"morgan@example.com"

request_id
string | null

Request identifier shared by every event of one request.

Example:

"9f2c1d7e4b8a4c3e"

mutations

Field-level changes the action made, when it recorded any.

metadata
Metadata · object

Additional context recorded with the event.