KosmoKrator

sales

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.

7 functions 6 read 1 write Bearer token auth

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 use the same stored profile from scripts, coding CLIs, Lua code mode, and the MCP gateway.

KeyEnv varTypeRequiredLabel
access_token ACTIVELY_ACCESS_TOKEN Secret secret yes Access Token
url ACTIVELY_URL URL url no API Base URL

Call Actively Headlessly

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

kosmo integrations:call actively.actively_list_organizations '{
  "limit": 1,
  "page": 1
}' --json

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

kosmo integrations:actively actively_list_organizations '{
  "limit": 1,
  "page": 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 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

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 Actively.

actively.actively_list_organizations

Read read

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.

Parameters
limit, page

Generic CLI call

kosmo integrations:call actively.actively_list_organizations '{"limit":1,"page":1}' --json

Provider shortcut

kosmo integrations:actively actively_list_organizations '{"limit":1,"page":1}' --json

actively.actively_get_current_user

Read read

Get the authenticated user's profile from Actively. Returns user name, email, role, and organization memberships.

Parameters
none

Generic CLI call

kosmo integrations:call actively.actively_get_current_user '{}' --json

Provider shortcut

kosmo integrations:actively actively_get_current_user '{}' --json

actively.actively_list_campaigns

Read read

List campaigns for an organization in Actively. Returns campaign details including title, type, status, and date range. Paginate with limit and page parameters.

Parameters
org_id, limit, page

Generic CLI call

kosmo integrations:call actively.actively_list_campaigns '{"org_id":"example_org_id","limit":1,"page":1}' --json

Provider shortcut

kosmo integrations:actively actively_list_campaigns '{"org_id":"example_org_id","limit":1,"page":1}' --json

actively.actively_get_campaign

Read read

Get details of a specific campaign in Actively. Returns the campaign title, type, status, date range, and all associated metadata.

Parameters
org_id, campaign_id

Generic CLI call

kosmo integrations:call actively.actively_get_campaign '{"org_id":"example_org_id","campaign_id":"example_campaign_id"}' --json

Provider shortcut

kosmo integrations:actively actively_get_campaign '{"org_id":"example_org_id","campaign_id":"example_campaign_id"}' --json

actively.actively_create_campaign

Write write

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.

Parameters
org_id, title, type, start_date, end_date

Generic CLI call

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

Provider shortcut

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

Read read

List contacts for an organization in Actively. Returns contact details including name, email, phone, and any associated metadata. Paginate with limit and page parameters.

Parameters
org_id, limit, page

Generic CLI call

kosmo integrations:call actively.actively_list_contacts '{"org_id":"example_org_id","limit":1,"page":1}' --json

Provider shortcut

kosmo integrations:actively actively_list_contacts '{"org_id":"example_org_id","limit":1,"page":1}' --json

actively.actively_get_contact

Read read

Get details of a specific contact in Actively. Returns the contact's name, email, phone, and all associated metadata.

Parameters
org_id, contact_id

Generic CLI call

kosmo integrations:call actively.actively_get_contact '{"org_id":"example_org_id","contact_id":"example_contact_id"}' --json

Provider shortcut

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

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.

Operation
Read read
Schema command
kosmo integrations:schema actively.actively_list_organizations --json
ParameterTypeRequiredDescription
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

Get the authenticated user's profile from Actively. Returns user name, email, role, and organization memberships.

Operation
Read read
Schema command
kosmo integrations:schema actively.actively_get_current_user --json
ParameterTypeRequiredDescription
No parameters.

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.

Operation
Read read
Schema command
kosmo integrations:schema actively.actively_list_campaigns --json
ParameterTypeRequiredDescription
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

Get details of a specific campaign in Actively. Returns the campaign title, type, status, date range, and all associated metadata.

Operation
Read read
Schema command
kosmo integrations:schema actively.actively_get_campaign --json
ParameterTypeRequiredDescription
org_id string yes The organization UUID.
campaign_id string yes The campaign UUID.

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.

Operation
Write write
Schema command
kosmo integrations:schema actively.actively_create_campaign --json
ParameterTypeRequiredDescription
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

List contacts for an organization in Actively. Returns contact details including name, email, phone, and any associated metadata. Paginate with limit and page parameters.

Operation
Read read
Schema command
kosmo integrations:schema actively.actively_list_contacts --json
ParameterTypeRequiredDescription
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

Get details of a specific contact in Actively. Returns the contact's name, email, phone, and all associated metadata.

Operation
Read read
Schema command
kosmo integrations:schema actively.actively_get_contact --json
ParameterTypeRequiredDescription
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.