Skip to content
API Reference

cli get-view

cli get-view — Micro CLI reference.

Command reference for CLI v1.0.0. Release source.

Read a view bundle

Synopsis

Returns the view bundle. Pass ?include=records to also fetch a page of records selected by the view in the same call; the response is then wrapped as {view, records}.

cli get-view [flags]

Examples

  cli get-view --team-id 7bebae29-5ec2-496d-a371-a1740b2f29af --view-object-type event --view-id 4496fc81-b665-4ab2-b9ed-e7580819f8bc

Options

  -c, --cursor include=records    Forwarded to the records sub-resource when include=records.
  -h, --help                      help for get-view
  -i, --include records           Comma-separated list of optional sub-resources to inline. Currently the only recognized value is records — when present, the response is `{view, records}` rather than the bare view bundle.
  -l, --limit include=records     Forwarded to the records sub-resource when include=records.
  -p, --page include=records      Forwarded to the records sub-resource when include=records.
  -t, --team-id string            [required]
      --view-id string            [required]
      --view-object-type string   options: action, deal, document, event, identity, organization [required]

Options inherited from parent commands

      --agent-mode             Enable structured errors and default TOON output for AI coding agents. Automatically enabled when a known agent environment is detected (CLAUDE_CODE, CURSOR_AGENT, etc.). Use --agent-mode=false to disable.
      --api-key x-api-key      Public API key generated from Micro settings. Sent as the x-api-key header and validated by AWS API Gateway in front of the service.
      --color string           Control colored output: auto (color when output is a TTY), always, or never. Respects NO_COLOR and FORCE_COLOR env vars. (default "auto")
  -d, --debug                  Log request and response diagnostics to stderr
      --dry-run                Preview the request that would be sent without executing it (output to stderr)
  -H, --header stringArray     Set a custom HTTP request header (format: "Key: Value"). Can be specified multiple times.
      --include-headers        Include HTTP response headers in the output
  -q, --jq string              Filter and transform output using a jq expression (e.g., '.name', '.items[] | .id')
      --no-interactive         Disable all interactive features (auto-prompting, explorer auto-launch, TUI forms)
  -o, --output-format string   Specify the output format. Options: pretty, json, yaml, table, toon. (default "pretty")
      --server string          Select a server by index (for indexed servers) or name (for named servers)
      --server-url string      Override the default server URL
      --timeout string         HTTP request timeout (e.g., 30s, 5m, 100ms)
      --usage                  Print the CLI Usage schema in KDL format

SEE ALSO

  • cli - cli command-line interface
micro.so