Activity API

A live feed of everything that happens in your workspace.

Module code activity · 2 actions · 2 data models · 2 events. A key or token never does more here than the person behind it can; row-level security applies exactly as in the app. Scopes: activity (everything), activity:read (read only) or activity:<capability>.

Resources

Lists take limit (up to 200), cursor, order (e.g. -created_at), fields and q; every other query parameter is a column filter: ?status=paid, ?total[gte]=100, ?id[in]=a,b, ?x=null.

Actions

activity.purge

Apply the activity retention policy — Deletes activity older than the workspace’s retention window. 0 keeps everything.

Needs activity:manage · removes or cannot be undone · asks a person to confirm when Era runs it

• Canonical address: POST /api/v1/actions/activity.purge

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: activity.purged

What it writes: activity (delete) — Removes rows older than the window

curl -X POST https://app.getera.io/api/v1/activities/actions/purge \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"days":1}'

{
  "ok": true,
  "result": "…",
  "events": [
    "activity.purged"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.activities.purge({
  days: 1
})

era activities purge \
  --days 1

{
  "name": "era__activity__purge",
  "arguments": {
    "days": 1
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold activity:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 retention_too_short · 429 slow down

activity.seal

Seal the audit trail — Chains every settled activity row to the one before it, so a later change is detectable.

Needs activity:manage · changes data

• Canonical address: POST /api/v1/actions/activity.seal

Input

This action takes no input.

Events it publishes: activity.sealed

What it writes: activity (update) — Writes prev_hash and row_hash on unsealed rows

curl -X POST https://app.getera.io/api/v1/activities/actions/seal \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "activity.sealed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.activities.seal()

era activities seal

{
  "name": "era__activity__seal",
  "arguments": {}
}

Errors: 401 no or expired credential · 403 the credential does not hold activity:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 429 slow down

Data models

Activity

Table activity · Resource activities

• GET /api/v1/activities
• GET /api/v1/activities/{id}

Primary key: id

Event

Table event · Resource events

• GET /api/v1/events
• GET /api/v1/events/{id}

Primary key: id

Events

Workflows and webhooks react to these events.