sales
Actively CLI for Shell Scripts
Use the Actively CLI for shell scripts with headless JSON commands, schema discovery, credentials, and permission controls.
7 functions 6 read 1 write Bearer token auth
Actively 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 Actively CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.
Command Shape
# Actively CLI for Shell Scripts
kosmokrator integrations:configure actively --set access_token="$ACTIVELY_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmo integrations:call actively.actively_list_organizations '{"limit":1,"page":1}' --json Discovery Before Execution
Agents and scripts can inspect Actively docs and schemas before choosing a function.
kosmo integrations:docs actively --json
kosmo integrations:docs actively.actively_list_organizations --json
kosmo integrations:schema actively.actively_list_organizations --json
kosmo integrations:search "Actively" --json
kosmo integrations:list --json Useful Actively CLI Functions
| Function | Type | Parameters | Description |
|---|---|---|---|
actively.actively_list_organizations | Read | limit, page | List organizations you have access to in Actively. Returns organization names and UUIDs needed for campaign and contact operations. Paginate with limit and page parameters. |
actively.actively_get_current_user | Read | none | Get the authenticated user's profile from Actively. Returns user name, email, role, and organization memberships. |
actively.actively_list_campaigns | Read | org_id, limit, page | List campaigns for an organization in Actively. Returns campaign details including title, type, status, and date range. Paginate with limit and page parameters. |
actively.actively_get_campaign | Read | org_id, campaign_id | Get details of a specific campaign in Actively. Returns the campaign title, type, status, date range, and all associated metadata. |
actively.actively_create_campaign | Write | org_id, title, type, start_date, end_date | Create a new campaign for an organization in Actively. Specify the campaign title, type (e.g., "email", "social", "ads"), and the start and end dates. |
actively.actively_list_contacts | Read | org_id, limit, page | List contacts for an organization in Actively. Returns contact details including name, email, phone, and any associated metadata. Paginate with limit and page parameters. |
actively.actively_get_contact | Read | org_id, contact_id | Get details of a specific contact in Actively. Returns the contact's name, email, phone, and all associated metadata. |
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.