Usage

Syntax

kobana <product> <resource> <method> [flags]

• <product> — banking, finance, billing, inbox, dunning or dashboards.
• <resource> — can be nested: entities, entities records, builder tools create-page.
• <method> — the action: list, get, create, update, delete, or an action specific to the resource (sync, rotate, verify...).

The API version never appears in the command — the CLI resolves the URL from the embedded OpenAPI spec.

Path, query and header parameters (such as X-Workspace-Id) go in --params; the request body goes in --json.

The whole surface is discoverable through --help, at every level:

kobana --help                       # products
kobana dashboards --help            # Magic Dashboard resources
kobana dashboards entities --help   # a resource's methods

dashboards resources

Resource	Description
data-sources	Data sources
entities	Entities
workspaces	Workspaces
builder	Portal builder
portal-settings	Portal settings
portal-custom-domains	Custom domains
portal-oauth-providers	OIDC providers
portal-users	Portal users
portal-user-mappings	Portal user mapping
checklists	Checklists
comments	Comments
assets	Assets
asset-types	Asset types
email-templates	Email templates
email-layouts	Email layouts
notifications	Notifications
webhooks	Webhooks
webhook-deliveries	Webhook deliveries
events	Events
api-keys	API keys
dashboard-users	Members
team-roles	Roles
permissions	Permissions
organization	Organization
settings	Settings
me	Token identity
usage	Usage
ai-usage	AI usage
rate-limits	Rate limits
audit-logs	Audit logs
exports	Exports
imports	Imports
backups	Backups
data-purges	Data purge
maintenance	Maintenance

Each resource has a page of its own, with the full command table and examples — see the catalogue.

Examples

# Data sources and the state of each one
kobana dashboards data-sources list --fields "id,name,kind,status,last_synced_at"

# Sync a data source now
kobana dashboards data-sources sync --dry-run --params '{"id": "DATA_SOURCE_ID"}'

# An entity's records, latest due date first
kobana dashboards entities records list \
  --params '{"id": "ENTITY_ID", "limit": 100, "sort": "due_date:desc"}'

# Portal users of another workspace
kobana dashboards portal-users list \
  --params '{"X-Workspace-Id": "WORKSPACE_ID"}' \
  --fields "id,email,tenant_id,status"

# List with automatic pagination (NDJSON)
kobana dashboards portal-users list --page-all --fields "id,email,tenant_id"

# Table output
kobana dashboards workspaces list --output-format table

# Save the response to a file
kobana dashboards workspaces export --params '{"id": "WORKSPACE_ID"}' --output workspace.json

Next steps

• Schema introspection — inspect any endpoint's parameters and body.
• Global flags — every flag a command accepts.
• Helpers — +verb shortcuts for common workflows.
• Resources — the full catalogue, resource by resource.