list_capability_events

List capability events and their delivery

read collection canonical-registry since 2026-10-01

Lists every capability event, newest first, a page at a time, each with its delivery to the consumers: whether it was delivered, how many tries and replays, and when and by whom it was last replayed. Waiting events are listed oldest first. Filters by event type, org, delivery state and a UTC date range. Each row says whether the caller may replay its delivery now. Staff only.

Contract

shape
collection
authority
read
evidence
none
subscription
false
permission
any one of: staff.read (the staff role staff_read held in the Internal org, tradehq_role.staff_role); a deactivated caller is refused first
idempotency
safe
emits
none
MCP tool
list_capability_events
REST
POST https://api.containertradehq.com/v1/cap/list_capability_events

Idempotency: a read: calling again changes nothing

Inputs

nametyperequiredvalidation
event_typeevent_nameoptionaltradehq-event-name; 3 to 64 characters
Only events of this type (org.settings_changed).
org_idorg_idoptionaltradehq-org-id; 1 to 20 characters
Only events about this org.
deliveryone_ofoptionalone of any, waiting, delivered, replayed; default "any"
any; waiting (not yet delivered, oldest first); delivered; or replayed (replayed at least once).
sincedateoptionaldate, YYYY-MM-DD
Only events recorded on or after this UTC day.
untildateoptionaldate, YYYY-MM-DD
Only events recorded on or before this UTC day.
limitintegeroptional1 to 200; default 50
The page size.
afteruuidoptionalUUID
The previous page's next_after.

Paginated: next next_after · page_max 200 · walk_max 10000 · ceiling declared

Response

  • items · object[]
  • next_after · stringnull · Pass as `after` for the next page; null on the last one.
Full JSON Schema
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "event_id": {
            "type": "string",
            "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$",
            "format": "uuid",
            "description": "The event.",
            "x-data-class": "operational"
          },
          "event_type": {
            "type": "string",
            "description": "What the event is, noun.past_verb, as the capability that emitted it declares it.",
            "x-data-class": "operational"
          },
          "tenant_org_id": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 20,
            "pattern": "^[A-Za-z0-9_-]{1,20}$",
            "format": "tradehq-org-id",
            "description": "The org the event is about; null for a platform event (an account, an announcement).",
            "x-data-class": "operational"
          },
          "tenant_org_name": {
            "type": [
              "string",
              "null"
            ],
            "description": "That org's name; null for a platform event.",
            "x-data-class": "operational"
          },
          "producer_capability": {
            "type": "string",
            "description": "The capability that emitted it: its id on contract 2, its name on contract 1.",
            "x-data-class": "operational"
          },
          "subject_type": {
            "type": "string",
            "description": "What the event is about: its type's noun.",
            "x-data-class": "operational"
          },
          "subject_id": {
            "type": [
              "string",
              "null"
            ],
            "description": "The subject's id, when the event's data names one.",
            "x-data-class": "operational"
          },
          "actor_chain": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string"
                },
                "id": {
                  "type": "string"
                }
              },
              "required": [
                "kind",
                "id"
              ]
            },
            "description": "Who acted, outermost first: the principal, then the OAuth client and the counterparty it acted through or for.",
            "x-data-class": "operational"
          },
          "occurred_at": {
            "type": "string",
            "format": "date-time",
            "description": "When the side effect happened.",
            "x-data-class": "operational"
          },
          "recorded_at": {
            "type": "string",
            "format": "date-time",
            "description": "When the event was recorded; the list's order.",
            "x-data-class": "operational"
          },
          "trace_id": {
            "type": [
              "string",
              "null"
            ],
            "description": "The call's trace.",
            "x-data-class": "operational"
          },
          "correlation_id": {
            "type": [
              "string",
              "null"
            ],
            "description": "What the event belongs with.",
            "x-data-class": "operational"
          },
          "data": {
            "type": "object",
            "description": "The event's data: ids and names, as the capability declares it. Never a secret.",
            "x-data-class": "operational"
          },
          "delivery": {
            "type": "object",
            "properties": {
              "delivered": {
                "type": "boolean"
              },
              "tries": {
                "type": "integer",
                "minimum": 0
              },
              "replays": {
                "type": "integer",
                "minimum": 0
              },
              "delivered_at": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              },
              "replayed_at": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              },
              "replayed_by": {
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "delivered",
              "tries",
              "replays",
              "delivered_at",
              "replayed_at",
              "replayed_by"
            ],
            "additionalProperties": false,
            "description": "{delivered, tries, replays, delivered_at, replayed_at, replayed_by}: the relay's state for the event.",
            "x-data-class": "operational"
          },
          "replayable": {
            "type": "boolean",
            "description": "Whether the caller may replay this delivery now: it is delivered, they hold staff.ops, and replaying is enabled for them.",
            "x-data-class": "operational"
          }
        },
        "required": [
          "event_id",
          "event_type",
          "tenant_org_id",
          "tenant_org_name",
          "producer_capability",
          "subject_type",
          "subject_id",
          "actor_chain",
          "occurred_at",
          "recorded_at",
          "trace_id",
          "correlation_id",
          "data",
          "delivery",
          "replayable"
        ],
        "additionalProperties": false
      },
      "maxItems": 200
    },
    "next_after": {
      "type": [
        "string",
        "null"
      ],
      "description": "Pass as `after` for the next page; null on the last one."
    }
  },
  "required": [
    "items",
    "next_after"
  ],
  "additionalProperties": false
}

Refusals

The platform refusals apply to every call: version, authentication, authority, validation and rate limits, each in the same envelope.

Surfaces

DesktopF
MobileF
APIF
MCPF
VoiceD4
PushN
OneBoxN
OutboundN
  • Voice: degraded: visualization
  • Push: emits nothing
  • OneBox: no document originates an event listing
  • Outbound: staff tooling; crosses to no counterparty

Events

None emitted.

Related

get_api_usage, list_api_keys, list_granted_capabilities, list_reports