Can I use ChurnZero as a CLI?

Yes. KosmoKrator exposes a ChurnZero CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose ChurnZero through MCP?

Yes. The KosmoKrator MCP gateway can expose selected ChurnZero tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are ChurnZero credentials stored?

ChurnZero credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for ChurnZero MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

sales

ChurnZero CLI for AI Agents

Use the ChurnZero CLI from KosmoKrator to call ChurnZero tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

7 functions 7 read 0 write API key auth

Submit ChurnZero feedback View package source

ChurnZero CLI Setup

ChurnZero can be configured headlessly with `kosmokrator integrations:configure churnzero`.

# 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 churnzero --set api_key="$CHURNZERO_API_KEY" --enable --read allow --write ask --json
kosmokrator integrations:doctor churnzero --json
kosmokrator integrations:status --json

Credentials

Authentication type: API key api_key. Configure credentials once, then use the same stored profile from scripts, coding CLIs, Lua code mode, and the MCP gateway.

Key	Env var	Type	Required	Label
`api_key`	`CHURNZERO_API_KEY`	Secret `secret`	yes	API Key
`url`	`CHURNZERO_URL`	URL `url`	no	API Base URL

Call ChurnZero Headlessly

Use the generic call form when another coding CLI or script needs a stable universal interface.

kosmo integrations:call churnzero.churnzero_list_accounts '{
  "search": "example_search",
  "page": 1,
  "perPage": 1
}' --json

Use the provider shortcut form for shorter human-facing commands.

kosmo integrations:churnzero churnzero_list_accounts '{
  "search": "example_search",
  "page": 1,
  "perPage": 1
}' --json

Agent Discovery Commands

These commands return structured output for coding agents that need to inspect capabilities 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

All CLI Functions

Every function below can be called headlessly. The generic form is stable across all integrations; the provider shortcut is shorter but specific to ChurnZero.

`churnzero.churnzero_list_accounts`

Read read

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.

Parameters: search, page, perPage

Generic CLI call

kosmo integrations:call churnzero.churnzero_list_accounts '{"search":"example_search","page":1,"perPage":1}' --json

Provider shortcut

kosmo integrations:churnzero churnzero_list_accounts '{"search":"example_search","page":1,"perPage":1}' --json

`churnzero.churnzero_get_account`

Read read

Get full details for a single account in ChurnZero, including health score, license information, custom fields, and associated data.

Parameters: id

Generic CLI call

kosmo integrations:call churnzero.churnzero_get_account '{"id":"example_id"}' --json

Provider shortcut

kosmo integrations:churnzero churnzero_get_account '{"id":"example_id"}' --json

`churnzero.churnzero_list_contacts`

Read read

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.

Parameters: account_id, search, page, perPage

Generic CLI call

kosmo integrations:call churnzero.churnzero_list_contacts '{"account_id":"example_account_id","search":"example_search","page":1,"perPage":1}' --json

Provider shortcut

kosmo integrations:churnzero churnzero_list_contacts '{"account_id":"example_account_id","search":"example_search","page":1,"perPage":1}' --json

`churnzero.churnzero_get_contact`

Read read

Get full details for a single contact in ChurnZero, including email, phone, role, account association, and custom fields.

Parameters: id

Generic CLI call

kosmo integrations:call churnzero.churnzero_get_contact '{"id":"example_id"}' --json

Provider shortcut

kosmo integrations:churnzero churnzero_get_contact '{"id":"example_id"}' --json

`churnzero.churnzero_list_alerts`

Read read

List alerts in ChurnZero — risk signals, usage drops, renewal reminders, and other notifications. Filter by account ID or alert status. Supports pagination.

Parameters: account_id, status, page, perPage

Generic CLI call

kosmo integrations:call churnzero.churnzero_list_alerts '{"account_id":"example_account_id","status":"example_status","page":1,"perPage":1}' --json

Provider shortcut

kosmo integrations:churnzero churnzero_list_alerts '{"account_id":"example_account_id","status":"example_status","page":1,"perPage":1}' --json

`churnzero.churnzero_list_usage`

Read read

List usage data in ChurnZero — track how customers engage with your product features. Filter by account ID or specific feature/module name. Supports pagination.

Parameters: account_id, feature, page, perPage

Generic CLI call

kosmo integrations:call churnzero.churnzero_list_usage '{"account_id":"example_account_id","feature":"example_feature","page":1,"perPage":1}' --json

Provider shortcut

kosmo integrations:churnzero churnzero_list_usage '{"account_id":"example_account_id","feature":"example_feature","page":1,"perPage":1}' --json

`churnzero.churnzero_get_current_user`

Read read

Get the profile of the currently authenticated ChurnZero user — name, email, role, tenant, and other account details.

Parameters: none

Generic CLI call

kosmo integrations:call churnzero.churnzero_get_current_user '{}' --json

Provider shortcut

kosmo integrations:churnzero churnzero_get_current_user '{}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

`churnzero.churnzero_list_accounts`

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.

Operation: Read read
Schema command: kosmo integrations:schema churnzero.churnzero_list_accounts --json

Parameter	Type	Required	Description
`search`	string	no	Search term to filter accounts by name or other attributes.
`page`	integer	no	Page number for pagination (default: 1).
`perPage`	integer	no	Number of results per page (default: 25, max: 100).

`churnzero.churnzero_get_account`

Get full details for a single account in ChurnZero, including health score, license information, custom fields, and associated data.

Operation: Read read
Schema command: kosmo integrations:schema churnzero.churnzero_get_account --json

Parameter	Type	Required	Description
`id`	string	yes	The account ID to retrieve.

`churnzero.churnzero_list_contacts`

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.

Operation: Read read
Schema command: kosmo integrations:schema churnzero.churnzero_list_contacts --json

Parameter	Type	Required	Description
`account_id`	string	no	Filter contacts by account ID.
`search`	string	no	Search term to filter contacts by name or email.
`page`	integer	no	Page number for pagination (default: 1).
`perPage`	integer	no	Number of results per page (default: 25, max: 100).

`churnzero.churnzero_get_contact`

Get full details for a single contact in ChurnZero, including email, phone, role, account association, and custom fields.

Operation: Read read
Schema command: kosmo integrations:schema churnzero.churnzero_get_contact --json

Parameter	Type	Required	Description
`id`	string	yes	The contact ID to retrieve.

`churnzero.churnzero_list_alerts`

List alerts in ChurnZero — risk signals, usage drops, renewal reminders, and other notifications. Filter by account ID or alert status. Supports pagination.

Operation: Read read
Schema command: kosmo integrations:schema churnzero.churnzero_list_alerts --json

Parameter	Type	Required	Description
`account_id`	string	no	Filter alerts by account ID.
`status`	string	no	Filter by alert status. Common values: "open", "dismissed", "snoozed".
`page`	integer	no	Page number for pagination (default: 1).
`perPage`	integer	no	Number of results per page (default: 25, max: 100).

`churnzero.churnzero_list_usage`

List usage data in ChurnZero — track how customers engage with your product features. Filter by account ID or specific feature/module name. Supports pagination.

Operation: Read read
Schema command: kosmo integrations:schema churnzero.churnzero_list_usage --json

Parameter	Type	Required	Description
`account_id`	string	no	Filter usage data by account ID.
`feature`	string	no	Filter by feature or module name.
`page`	integer	no	Page number for pagination (default: 1).
`perPage`	integer	no	Number of results per page (default: 25, max: 100).

`churnzero.churnzero_get_current_user`

Get the profile of the currently authenticated ChurnZero user — name, email, role, tenant, and other account details.

Operation: Read read
Schema command: kosmo integrations:schema churnzero.churnzero_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.