sales
ChurnZero CLI for Shell Scripts
Use the ChurnZero CLI for shell scripts with headless JSON commands, schema discovery, credentials, and permission controls.
7 functions 7 read 0 write API key auth
ChurnZero CLI for Shell Scripts
Call integration functions from shell scripts with stable JSON input and output.
Use shell scripts for small local automations that need one or more integration calls. The ChurnZero CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.
Command Shape
# ChurnZero CLI for Shell Scripts
kosmokrator integrations:configure churnzero --set api_key="$CHURNZERO_API_KEY" --enable --read allow --write ask --json
kosmo integrations:call churnzero.churnzero_list_accounts '{"search":"example_search","page":1,"perPage":1}' --json Discovery Before Execution
Agents and scripts can inspect ChurnZero docs and schemas before choosing a function.
kosmo integrations:docs churnzero --json
kosmo integrations:docs churnzero.churnzero_list_accounts --json
kosmo integrations:schema churnzero.churnzero_list_accounts --json
kosmo integrations:search "ChurnZero" --json
kosmo integrations:list --json Useful ChurnZero CLI Functions
| Function | Type | Parameters | Description |
|---|---|---|---|
churnzero.churnzero_list_accounts | Read | search, page, perPage | Search and list accounts in ChurnZero. Use the search parameter to filter accounts by name or other attributes. Returns a paginated list of accounts with their details. |
churnzero.churnzero_get_account | Read | id | Get full details for a single account in ChurnZero, including health score, license information, custom fields, and associated data. |
churnzero.churnzero_list_contacts | Read | account_id, search, page, perPage | List contacts in ChurnZero. Optionally filter by account ID to get contacts for a specific account, or use search to find contacts by name or email. Supports pagination. |
churnzero.churnzero_get_contact | Read | id | Get full details for a single contact in ChurnZero, including email, phone, role, account association, and custom fields. |
churnzero.churnzero_list_alerts | Read | account_id, status, page, perPage | List alerts in ChurnZero — risk signals, usage drops, renewal reminders, and other notifications. Filter by account ID or alert status. Supports pagination. |
churnzero.churnzero_list_usage | Read | account_id, feature, page, perPage | List usage data in ChurnZero — track how customers engage with your product features. Filter by account ID or specific feature/module name. Supports pagination. |
churnzero.churnzero_get_current_user | Read | none | Get the profile of the currently authenticated ChurnZero user — name, email, role, tenant, and other account details. |
Automation Notes
- Use
--jsonfor machine-readable output. - Keep credentials out of argv by using environment variables or stored KosmoKrator configuration.
- Configure read/write policy before unattended runs; use
--forceonly for trusted automation. - Use the MCP gateway instead when the agent needs dynamic tool discovery inside a conversation.