# shared_views.create

Create a link to selected reports or documents. Anyone holding it can read that data without an account until expiry or revocation.

## What it does

Create a capability link that shows chosen reports and documents to anyone holding it, without an account, at /e/{slug}/share/{token} on this server (the kernel is host-agnostic, so the path is what it can promise). reports are public report kinds that need no period (balances, statements, aging, cap table, activity balances; as_of is the moment the link is opened); documents are immutable artifact ids; contracts are contract ids. Custom definitions pin {id,version}; mode defaults to frozen (results captured now), or live (pinned SQL rerun on view).

Mode applies to custom definitions; built-in reports are live. No share expires by default. Supply expiresAt explicitly to set a UTC expiry. The token is returned once here and again by shared_views list. Revoke with shared_views.revoke.

## Before you send it

An authorized OAuth connection may call it, including a headless client. Effective membership, application grant and token permissions still apply. Describe `shared_views.create` through `GET /v1/catalog/commands/{name}` before acting.

This command does not accept `source_document_id` in its envelope. Any input evidence requirements remain as documented below.

## Inputs

Put these fields inside the envelope's `input` object. The outer envelope names the command, a stable `idempotency_key` and `effective_at`; [request and recovery rules](/docs/api/) explain those separately. Use exact minor-unit integer strings for monetary fields. Take existing IDs from prior reads or command results; choose a new identity only where the command asks for one.

Required means required within its containing object; an optional parent can be omitted.

| Field | Type | Required | Meaning and accepted values |
|---|---|---|---|
| `description` | string | Yes |  Minimum length: `1`. Maximum length: `200`. Example: `"Investor update"`. |
| `mode` | string | No |  Choose `"live"`, `"frozen"`. Default: `"frozen"`. |
| `definitions` | array | No |  Items: object. Maximum items: `12`. |
| `definitions[].id` | string | Yes |  Pattern: `"^rpt_[0-9A-HJKMNP-TV-Z]{26}$"`. |
| `definitions[].version` | integer | Yes |  Minimum: `1`. |
| `definitions[].params` | object | No | Frozen links only: the values to capture the report with, by parameter name (a month as YYYY-MM, a range as name_from and name_to). Absent, its defaults on the day the link is made. A live link's viewer chooses within the report's bounds.  |
| `reports` | array | No |  Each item must be `"activity_balances"`, `"activity_claims"`, `"pipeline"`, `"activity_effects"`, `"balances"`, `"balance_sheet"`, `"capital_accounts"`, `"income_statement"`, `"income_statement_periods"`, `"recognition"`, `"amortization"`, `"aging"`, `"unit_economics"`, `"cap_table"`. |
| `documents` | array | No |  Items: string. |
| `contracts` | array | No |  Items: string. |
| `currency` | string | No |  Minimum length: `3`. Maximum length: `16`. |
| `expiresAt` | string | No |  Format: date-time. Example: `"2027-01-01T00:00:00Z"`. |

## After acceptance

When the command emits events, its documented effects and receipt are recorded in the command transaction. The response returns `commandId`, `replayed`, the command-specific `result` below and emitted `events` with their IDs and CIDs. A command is not automatically a cash movement or revenue recognition: use the behavior above to determine what this command records.

Inspect `result` and the affected records or reports before continuing. Save returned identifiers for later calls. Fetch `GET /v1/commands/{id}` with `commandId` to recover the accepted receipt; retry the same intent with the same idempotency key if the response was lost. Some commands can succeed with `events: []` and return a transient result and `commandId` without persisting a receipt. A lookup of that ID can return null; retain the returned result and verify the affected record. Retrying can re-evaluate the current state rather than replay a stored result. A domain `no_change` is a separate success outcome with no persisted receipt.

### Result fields

Required means required within its containing object; an optional parent can be omitted.

| Field | Type | Required | Meaning and accepted values |
|---|---|---|---|
| `viewId` | string | Yes |   |
| `token` | string | Yes |   |
| `description` | string | Yes |   |
| `reports` | array | Yes |  Items: string. |
| `documents` | array | Yes |  Items: string. |
| `contracts` | array | Yes |  Items: string. |
| `currency` | string | Yes |   |
| `expiresAt` | string | No |   |
| `mode` | string | No |  Choose `"live"`, `"frozen"`. |
| `definitions` | array | No |  Items: object. Maximum items: `12`. |
| `definitions[].id` | string | Yes |  Pattern: `"^rpt_[0-9A-HJKMNP-TV-Z]{26}$"`. |
| `definitions[].version` | integer | Yes |  Minimum: `1`. |
| `definitions[].snapshotCid` | string | No |   |
| `definitions[].snapshotDocumentId` | string | No |   |
| `capturedAt` | string | No |   |
| `createdEventId` | integer | No |   |
| `revokedEventId` | integer | No |   |


[All commands](/docs/command-reference/) · [Operation and errors](/docs/api-reference/operations/commands-execute/) · [Reusable schemas](/docs/api-reference/components/)

Keep credentials out of prompts; rehearse writes only in a disposable sandbox.

## Exact request schema


```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "const": "shared_views.create"
    },
    "input": {
      "type": "object",
      "properties": {
        "description": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "mode": {
          "enum": [
            "live",
            "frozen"
          ],
          "default": "frozen"
        },
        "definitions": {
          "type": "array",
          "maxItems": 12,
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^rpt_[0-9A-HJKMNP-TV-Z]{26}$"
              },
              "version": {
                "type": "integer",
                "minimum": 1
              },
              "params": {
                "type": "object",
                "description": "Frozen links only: the values to capture the report with, by parameter name (a month as YYYY-MM, a range as name_from and name_to). Absent, its defaults on the day the link is made. A live link's viewer chooses within the report's bounds.",
                "additionalProperties": {
                  "type": [
                    "string",
                    "integer"
                  ]
                }
              }
            },
            "required": [
              "id",
              "version"
            ],
            "additionalProperties": false
          }
        },
        "reports": {
          "type": "array",
          "items": {
            "enum": [
              "activity_balances",
              "activity_claims",
              "pipeline",
              "activity_effects",
              "balances",
              "balance_sheet",
              "capital_accounts",
              "income_statement",
              "income_statement_periods",
              "recognition",
              "amortization",
              "aging",
              "unit_economics",
              "cap_table"
            ]
          },
          "uniqueItems": true
        },
        "documents": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          },
          "uniqueItems": true
        },
        "contracts": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          },
          "uniqueItems": true
        },
        "currency": {
          "type": "string",
          "minLength": 3,
          "maxLength": 16
        },
        "expiresAt": {
          "type": "string",
          "format": "date-time"
        }
      },
      "required": [
        "description"
      ],
      "additionalProperties": false
    },
    "idempotency_key": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "effective_at": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
    }
  },
  "required": [
    "name",
    "input",
    "idempotency_key",
    "effective_at"
  ],
  "additionalProperties": false
}
```

## Accepted command receipt


```json
{
  "type": "object",
  "required": [
    "commandId",
    "replayed",
    "result",
    "events"
  ],
  "properties": {
    "commandId": {
      "type": "string"
    },
    "replayed": {
      "type": "boolean"
    },
    "imported": {
      "const": true,
      "description": "The command's events are history from before the business joined Economico, recorded as an import: free of monthly events."
    },
    "result": {
      "type": "object",
      "properties": {
        "viewId": {
          "type": "string"
        },
        "token": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "reports": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          },
          "uniqueItems": true
        },
        "documents": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          },
          "uniqueItems": true
        },
        "contracts": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          },
          "uniqueItems": true
        },
        "currency": {
          "type": "string"
        },
        "expiresAt": {
          "type": "string"
        },
        "mode": {
          "enum": [
            "live",
            "frozen"
          ]
        },
        "definitions": {
          "type": "array",
          "maxItems": 12,
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^rpt_[0-9A-HJKMNP-TV-Z]{26}$"
              },
              "version": {
                "type": "integer",
                "minimum": 1
              },
              "snapshotCid": {
                "type": "string"
              },
              "snapshotDocumentId": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "version"
            ],
            "additionalProperties": false
          }
        },
        "capturedAt": {
          "type": "string"
        },
        "createdEventId": {
          "type": "integer"
        },
        "revokedEventId": {
          "type": "integer"
        }
      },
      "required": [
        "viewId",
        "token",
        "description",
        "reports",
        "documents",
        "contracts",
        "currency"
      ]
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "cid": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

## Example request


```json
{
  "name": "shared_views.create",
  "input": {
    "description": "Investor update",
    "reports": [
      "balance_sheet",
      "income_statement"
    ],
    "expiresAt": "2027-01-01T00:00:00Z"
  },
  "effective_at": "2026-09-01T00:00:00Z",
  "idempotency_key": "shared_views.create-example-0"
}
```