data
Wealthbox CLI for AI Agents
Use the Wealthbox CLI from KosmoKrator to call Wealthbox tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.Wealthbox CLI Setup
Wealthbox can be configured headlessly with `kosmokrator integrations:configure wealthbox`.
# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash
# Configure and verify this integration.
kosmokrator integrations:configure wealthbox --set access_token="$WEALTHBOX_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmokrator integrations:doctor wealthbox --json
kosmokrator integrations:status --json Credentials
Authentication type: Bearer token bearer_token. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.
| Key | Env var | Type | Required | Label |
|---|---|---|---|---|
access_token | WEALTHBOX_ACCESS_TOKEN | Secret secret | yes | Access Token |
Command Patterns
The generic command is stable across every integration. The provider shortcut is shorter for humans.
kosmo integrations:call wealthbox.wealthbox_list_contacts '{"page":1,"per_page":1,"search":"example_search"}' --json kosmo integrations:wealthbox wealthbox_list_contacts '{"page":1,"per_page":1,"search":"example_search"}' --json Discovery
These commands return structured output for coding agents that need to inspect capabilities before choosing a function.
kosmo integrations:docs wealthbox --json
kosmo integrations:docs wealthbox.wealthbox_list_contacts --json
kosmo integrations:schema wealthbox.wealthbox_list_contacts --json
kosmo integrations:search "Wealthbox" --json
kosmo integrations:list --json Automation Contexts
The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.
CLI Functions
Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.
wealthbox.wealthbox_list_contacts
List contacts from Wealthbox CRM. Returns a paginated list of contacts with their details. Use search to filter by name or email.
read - Parameters
- page, per_page, search
kosmo integrations:call wealthbox.wealthbox_list_contacts '{"page":1,"per_page":1,"search":"example_search"}' --json kosmo integrations:wealthbox wealthbox_list_contacts '{"page":1,"per_page":1,"search":"example_search"}' --json wealthbox.wealthbox_get_contact
Get a specific contact from Wealthbox CRM by their ID. Returns full contact details including name, email, phone, address, and custom fields.
read - Parameters
- id
kosmo integrations:call wealthbox.wealthbox_get_contact '{"id":1}' --json kosmo integrations:wealthbox wealthbox_get_contact '{"id":1}' --json wealthbox.wealthbox_create_contact
Create a new contact in Wealthbox CRM. At minimum provide a first name or last name. You can also include email, phone, address, and other contact details.
write - Parameters
- first_name, last_name, email, phone, street, city, state, zip, type, tags
kosmo integrations:call wealthbox.wealthbox_create_contact '{"first_name":"example_first_name","last_name":"example_last_name","email":"example_email","phone":"example_phone","street":"example_street","city":"example_city","state":"example_state","zip":"example_zip"}' --json kosmo integrations:wealthbox wealthbox_create_contact '{"first_name":"example_first_name","last_name":"example_last_name","email":"example_email","phone":"example_phone","street":"example_street","city":"example_city","state":"example_state","zip":"example_zip"}' --json wealthbox.wealthbox_list_tasks
List tasks from Wealthbox CRM. Returns a paginated list of tasks with their details including name, due date, status, and assignee.
read - Parameters
- page, per_page, status
kosmo integrations:call wealthbox.wealthbox_list_tasks '{"page":1,"per_page":1,"status":"example_status"}' --json kosmo integrations:wealthbox wealthbox_list_tasks '{"page":1,"per_page":1,"status":"example_status"}' --json wealthbox.wealthbox_create_task
Create a new task in Wealthbox CRM. Provide a task name and optionally a due date, description, and assignee.
write - Parameters
- name, due_date, description, assignee_id, contact_id, priority
kosmo integrations:call wealthbox.wealthbox_create_task '{"name":"example_name","due_date":"example_due_date","description":"example_description","assignee_id":1,"contact_id":1,"priority":"example_priority"}' --json kosmo integrations:wealthbox wealthbox_create_task '{"name":"example_name","due_date":"example_due_date","description":"example_description","assignee_id":1,"contact_id":1,"priority":"example_priority"}' --json wealthbox.wealthbox_list_opportunities
List opportunities (sales pipeline) from Wealthbox CRM. Returns a paginated list of opportunities with details like name, value, stage, and associated contact.
read - Parameters
- page, per_page, status
kosmo integrations:call wealthbox.wealthbox_list_opportunities '{"page":1,"per_page":1,"status":"example_status"}' --json kosmo integrations:wealthbox wealthbox_list_opportunities '{"page":1,"per_page":1,"status":"example_status"}' --json wealthbox.wealthbox_list_workflows
List workflows from Wealthbox CRM. Returns a paginated list of workflows with their steps, status, and associated contacts.
read - Parameters
- page, per_page
kosmo integrations:call wealthbox.wealthbox_list_workflows '{"page":1,"per_page":1}' --json kosmo integrations:wealthbox wealthbox_list_workflows '{"page":1,"per_page":1}' --json wealthbox.wealthbox_list_events
List calendar events from Wealthbox CRM. Returns a paginated list of events with their title, date, time, and associated contacts.
read - Parameters
- page, per_page, start_date, end_date
kosmo integrations:call wealthbox.wealthbox_list_events '{"page":1,"per_page":1,"start_date":"example_start_date","end_date":"example_end_date"}' --json kosmo integrations:wealthbox wealthbox_list_events '{"page":1,"per_page":1,"start_date":"example_start_date","end_date":"example_end_date"}' --json wealthbox.wealthbox_get_current_user
Get the currently authenticated Wealthbox user. Returns user profile information including name, email, and account details.
read - Parameters
- none
kosmo integrations:call wealthbox.wealthbox_get_current_user '{}' --json kosmo integrations:wealthbox wealthbox_get_current_user '{}' --json Function Schemas
Use these parameter tables when building CLI payloads without calling integrations:schema first.
wealthbox.wealthbox_list_contacts 3 parameters
kosmo integrations:schema wealthbox.wealthbox_list_contacts --json | Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | no | Page number for pagination (default: 1). |
per_page | integer | no | Number of contacts per page (default: 25, max: 200). |
search | string | no | Search term to filter contacts by name or email. |
wealthbox.wealthbox_get_contact 1 parameters
kosmo integrations:schema wealthbox.wealthbox_get_contact --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | integer | yes | The contact ID in Wealthbox. |
wealthbox.wealthbox_create_contact 10 parameters
kosmo integrations:schema wealthbox.wealthbox_create_contact --json | Parameter | Type | Required | Description |
|---|---|---|---|
first_name | string | no | Contact's first name. |
last_name | string | no | Contact's last name. |
email | string | no | Contact's email address. |
phone | string | no | Contact's phone number. |
street | string | no | Street address. |
city | string | no | City. |
state | string | no | State or province. |
zip | string | no | ZIP or postal code. |
type | string | no | Contact type (e.g., "Client", "Prospect", "Lead"). |
tags | array | no | Tags to assign to the contact. |
wealthbox.wealthbox_list_tasks 3 parameters
kosmo integrations:schema wealthbox.wealthbox_list_tasks --json | Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | no | Page number for pagination (default: 1). |
per_page | integer | no | Number of tasks per page (default: 25, max: 200). |
status | string | no | Filter by task status (e.g., "open", "completed"). |
wealthbox.wealthbox_create_task 6 parameters
kosmo integrations:schema wealthbox.wealthbox_create_task --json | Parameter | Type | Required | Description |
|---|---|---|---|
name | string | yes | The task name or title. |
due_date | string | no | Due date in ISO 8601 format (e.g., "2026-04-15"). |
description | string | no | Task description or notes. |
assignee_id | integer | no | User ID of the assignee. |
contact_id | integer | no | Link the task to a contact by their ID. |
priority | string | no | Task priority (e.g., "high", "medium", "low"). |
wealthbox.wealthbox_list_opportunities 3 parameters
kosmo integrations:schema wealthbox.wealthbox_list_opportunities --json | Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | no | Page number for pagination (default: 1). |
per_page | integer | no | Number of opportunities per page (default: 25, max: 200). |
status | string | no | Filter by opportunity status (e.g., "open", "won", "lost"). |
wealthbox.wealthbox_list_workflows 2 parameters
kosmo integrations:schema wealthbox.wealthbox_list_workflows --json | Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | no | Page number for pagination (default: 1). |
per_page | integer | no | Number of workflows per page (default: 25, max: 200). |
wealthbox.wealthbox_list_events 4 parameters
kosmo integrations:schema wealthbox.wealthbox_list_events --json | Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | no | Page number for pagination (default: 1). |
per_page | integer | no | Number of events per page (default: 25, max: 200). |
start_date | string | no | Filter events starting from this date (ISO 8601, e.g., "2026-04-01"). |
end_date | string | no | Filter events up to this date (ISO 8601, e.g., "2026-04-30"). |
wealthbox.wealthbox_get_current_user 0 parameters
kosmo integrations:schema wealthbox.wealthbox_get_current_user --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
Permissions
Headless calls still follow the integration read/write permission policy. Configure read/write defaults with
integrations:configure. Add --force only for trusted automation that should bypass that policy.