YOUHODLERBusiness API
Get access
View as Markdown

getList events

Required capabilityevents.read

Lists tenant-visible platform events. If omitted, scope_ref is derived from the authenticated enterprise or client context.

Request

Request URL

GET
GET /events

Responses

Response

application/json
{
  "items": [
    {
      "aggregate": {
        "type": "withdrawal",
        "id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b"
      },
      "data": {
        "operation_id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
        "status": "executed"
      },
      "event_type": "operations.withdrawal.executed.v1",
      "id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
      "metadata": null,
      "occurred_at": "2026-05-01T10:00:00Z",
      "partition_key": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
      "published_at": "2026-05-01T10:00:00Z",
      "resource": "event",
      "schema_version": 1,
      "scope_ref": "clients/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
      "subject_attribution": {
        "actor": null,
        "approved_by": null,
        "authenticated_principal": {
          "id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
          "kind": "user",
          "tenant_ref": "enterprises/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b"
        },
        "enterprise_binding": {
          "tenant_type": "enterprise",
          "topology_ref": "enterprises/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b"
        },
        "federation": null,
        "identity_source": "platform-managed",
        "initiated_by": null,
        "subject": {
          "id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
          "kind": "user",
          "tenant_ref": "enterprises/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b"
        }
      },
      "trace_id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b"
    }
  ],
  "next_page_token": null
}

Operation succeeded.