productivity
Actively CLI for AI Agents
Use the Actively CLI from KosmoKrator to call Actively tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.Actively CLI Setup
Actively can be configured headlessly with `kosmokrator integrations:configure actively`.
# 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 actively --set access_token="$ACTIVELY_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmokrator integrations:doctor actively --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 | ACTIVELY_ACCESS_TOKEN | Secret secret | yes | Access Token |
url | ACTIVELY_URL | URL url | no | API Base URL |
Command Patterns
The generic command is stable across every integration. The provider shortcut is shorter for humans.
kosmo integrations:call actively.actively_list_organizations '{"limit":1,"page":1}' --json kosmo integrations:actively actively_list_organizations '{"limit":1,"page":1}' --json Discovery
These commands return structured output for coding agents that need to inspect capabilities 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 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.
actively.actively_list_organizations
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.
read - Parameters
- limit, page
kosmo integrations:call actively.actively_list_organizations '{"limit":1,"page":1}' --json kosmo integrations:actively actively_list_organizations '{"limit":1,"page":1}' --json actively.actively_get_current_user
Get the authenticated user's profile from Actively. Returns user name, email, role, and organization memberships.
read - Parameters
- none
kosmo integrations:call actively.actively_get_current_user '{}' --json kosmo integrations:actively actively_get_current_user '{}' --json actively.actively_list_campaigns
List campaigns for an organization in Actively. Returns campaign details including title, type, status, and date range. Paginate with limit and page parameters.
read - Parameters
- org_id, limit, page
kosmo integrations:call actively.actively_list_campaigns '{"org_id":"example_org_id","limit":1,"page":1}' --json kosmo integrations:actively actively_list_campaigns '{"org_id":"example_org_id","limit":1,"page":1}' --json actively.actively_get_campaign
Get details of a specific campaign in Actively. Returns the campaign title, type, status, date range, and all associated metadata.
read - Parameters
- org_id, campaign_id
kosmo integrations:call actively.actively_get_campaign '{"org_id":"example_org_id","campaign_id":"example_campaign_id"}' --json kosmo integrations:actively actively_get_campaign '{"org_id":"example_org_id","campaign_id":"example_campaign_id"}' --json actively.actively_create_campaign
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.
write - Parameters
- org_id, title, type, start_date, end_date
kosmo integrations:call actively.actively_create_campaign '{"org_id":"example_org_id","title":"example_title","type":"example_type","start_date":"example_start_date","end_date":"example_end_date"}' --json kosmo integrations:actively actively_create_campaign '{"org_id":"example_org_id","title":"example_title","type":"example_type","start_date":"example_start_date","end_date":"example_end_date"}' --json actively.actively_list_contacts
List contacts for an organization in Actively. Returns contact details including name, email, phone, and any associated metadata. Paginate with limit and page parameters.
read - Parameters
- org_id, limit, page
kosmo integrations:call actively.actively_list_contacts '{"org_id":"example_org_id","limit":1,"page":1}' --json kosmo integrations:actively actively_list_contacts '{"org_id":"example_org_id","limit":1,"page":1}' --json actively.actively_get_contact
Get details of a specific contact in Actively. Returns the contact's name, email, phone, and all associated metadata.
read - Parameters
- org_id, contact_id
kosmo integrations:call actively.actively_get_contact '{"org_id":"example_org_id","contact_id":"example_contact_id"}' --json kosmo integrations:actively actively_get_contact '{"org_id":"example_org_id","contact_id":"example_contact_id"}' --json Function Schemas
Use these parameter tables when building CLI payloads without calling integrations:schema first.
actively.actively_list_organizations 2 parameters
kosmo integrations:schema actively.actively_list_organizations --json | Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Maximum number of organizations to return (default: 25). |
page | integer | no | Page number for pagination (default: 1). |
actively.actively_get_current_user 0 parameters
kosmo integrations:schema actively.actively_get_current_user --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
actively.actively_list_campaigns 3 parameters
kosmo integrations:schema actively.actively_list_campaigns --json | Parameter | Type | Required | Description |
|---|---|---|---|
org_id | string | yes | The organization UUID. |
limit | integer | no | Maximum number of campaigns to return (default: 25). |
page | integer | no | Page number for pagination (default: 1). |
actively.actively_get_campaign 2 parameters
kosmo integrations:schema actively.actively_get_campaign --json | Parameter | Type | Required | Description |
|---|---|---|---|
org_id | string | yes | The organization UUID. |
campaign_id | string | yes | The campaign UUID. |
actively.actively_create_campaign 5 parameters
kosmo integrations:schema actively.actively_create_campaign --json | Parameter | Type | Required | Description |
|---|---|---|---|
org_id | string | yes | The organization UUID. |
title | string | yes | The campaign title. |
type | string | yes | The campaign type (e.g., "email", "social", "ads"). |
start_date | string | yes | Campaign start date in ISO 8601 format (e.g., "2026-01-01"). |
end_date | string | yes | Campaign end date in ISO 8601 format (e.g., "2026-03-31"). |
actively.actively_list_contacts 3 parameters
kosmo integrations:schema actively.actively_list_contacts --json | Parameter | Type | Required | Description |
|---|---|---|---|
org_id | string | yes | The organization UUID. |
limit | integer | no | Maximum number of contacts to return (default: 25). |
page | integer | no | Page number for pagination (default: 1). |
actively.actively_get_contact 2 parameters
kosmo integrations:schema actively.actively_get_contact --json | Parameter | Type | Required | Description |
|---|---|---|---|
org_id | string | yes | The organization UUID. |
contact_id | string | yes | The contact UUID. |
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.