Skip to main content
GET
/
activity
/
{id}
Retrieve a single activity event
curl --request GET \
  --url https://api.arcuserp.com/v1/activity/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "act_550e8400e29b41d4a716446655440000",
  "object": "activity_event",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "actor": {
    "type": "user",
    "id": "<string>",
    "label": "<string>",
    "on_behalf_of": {
      "type": "user",
      "id": "<string>",
      "label": "<string>"
    }
  },
  "action": "account.created",
  "resource_type": "account",
  "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource_label": "<string>",
  "description": "<string>",
  "severity": "info",
  "outcome": "success",
  "error_code": "<string>",
  "request_id": "<string>",
  "metadata": {},
  "diff": {
    "before": "<unknown>",
    "after": "<unknown>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Path Parameters

id
string
required

Public activity id in format act_ or bare UUID.

Response

Single activity event.

A single activity log event (R11 envelope). Activity events are created automatically by canonical handlers via logActivity(). The public id uses the format act_ (UUID without dashes, prefixed with 'act_').

Internal-only fields stripped from this envelope: prev_hash, entry_hash (audit chain integrity), archived_at, archive_uri (S3 archive pointer). These fields are admin-only and not exposed via the public API.

id
string
required

Public activity id in format act_.

Example:

"act_550e8400e29b41d4a716446655440000"

object
enum<string>
required
Available options:
activity_event
entity_id
string<uuid>
required

Entity this event belongs to (Layer 1 scoping).

created_at
string<date-time>
required

Timestamp when the event was created (immutable; point-in-time).

actor
object
required

The actor who performed the action. actor.label is a point-in-time snapshot (denormalized at insert time; the live user may have been renamed since).

action
string
required

Action string from the canonical ACTION_VALUES vocabulary (utils/activity-actions.mjs). Examples: account.created, product.updated, order.fulfilled, journal_entry.posted.

Example:

"account.created"

resource_type
string
required

Type of the resource this event concerns (e.g. account, product, order).

Example:

"account"

resource_id
string<uuid> | null

UUID of the resource this event concerns (null for entity-level events).

resource_label
string | null

Human-readable label of the resource at time of event (denormalized snapshot).

description
string | null

Human-readable description of what happened.

severity
enum<string>

Severity level of the event.

Available options:
info,
notice,
warning,
critical
Example:

"info"

outcome
enum<string>

Outcome of the action.

Available options:
success,
failure,
denied
Example:

"success"

error_code
string | null

Error code if outcome=failure (null for success).

request_id
string | null

HTTP request_id for tracing (maps to CloudWatch log stream).

metadata
object

Additional structured metadata for this event. The internal _actor block is stripped and surfaced as the top-level actor field.

diff
object

State snapshot diff for the activity event.