Can I use Actively as a CLI?

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

Can I expose Actively through MCP?

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

Where are Actively credentials stored?

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

Can I deny write access for Actively MCP tools?

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

sales

Actively Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Actively KosmoKrator integration.

7 functions 6 read 1 write Bearer token auth

Submit Actively feedback View package source

Lua Namespace

Agents call this integration through app.integrations.actively.*. Use lua_read_doc("integrations.actively") inside KosmoKrator to discover the same reference at runtime.

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Actively CRM — Lua API Reference

list_organizations

List organizations you have access to in Actively.

Parameters

Name	Type	Required	Description
`limit`	integer	no	Max organizations to return (default: 25)
`page`	integer	no	Page number for pagination (default: 1)

Example

local result = app.integrations.actively.list_organizations({
  limit = 10,
  page = 1
})

for _, org in ipairs(result.data) do
  print(org.id .. ": " .. org.name)
end

get_current_user

Get the authenticated user’s profile from Actively.

Parameters

None.

Example

local user = app.integrations.actively.get_current_user({})
print("Logged in as: " .. user.name .. " (" .. user.email .. ")")

list_campaigns

List campaigns for an organization in Actively.

Parameters

Name	Type	Required	Description
`org_id`	string	yes	The organization UUID
`limit`	integer	no	Max campaigns to return (default: 25)
`page`	integer	no	Page number for pagination (default: 1)

Example

local result = app.integrations.actively.list_campaigns({
  org_id = "org_abc123",
  limit = 10,
  page = 1
})

for _, campaign in ipairs(result.data) do
  print(campaign.title .. " (" .. campaign.type .. ") - " .. campaign.status)
end

get_campaign

Get details of a specific campaign in Actively.

Parameters

Name	Type	Required	Description
`org_id`	string	yes	The organization UUID
`campaign_id`	string	yes	The campaign UUID

Example

local campaign = app.integrations.actively.get_campaign({
  org_id = "org_abc123",
  campaign_id = "camp_xyz789"
})

print(campaign.title)
print("Type: " .. campaign.type)
print("Period: " .. campaign.start_date .. " to " .. campaign.end_date)

create_campaign

Create a new campaign for an organization in Actively.

Parameters

Name	Type	Required	Description
`org_id`	string	yes	The organization UUID
`title`	string	yes	The campaign title
`type`	string	yes	Campaign type (e.g., `"email"`, `"social"`, `"ads"`)
`start_date`	string	yes	Start date in ISO 8601 format (e.g., `"2026-01-01"`)
`end_date`	string	yes	End date in ISO 8601 format (e.g., `"2026-03-31"`)

Example

local campaign = app.integrations.actively.create_campaign({
  org_id = "org_abc123",
  title = "Q1 Product Launch",
  type = "email",
  start_date = "2026-01-15",
  end_date = "2026-03-31"
})

print("Created campaign: " .. campaign.id)

list_contacts

List contacts for an organization in Actively.

Parameters

Name	Type	Required	Description
`org_id`	string	yes	The organization UUID
`limit`	integer	no	Max contacts to return (default: 25)
`page`	integer	no	Page number for pagination (default: 1)

Example

local result = app.integrations.actively.list_contacts({
  org_id = "org_abc123",
  limit = 50,
  page = 1
})

for _, contact in ipairs(result.data) do
  print(contact.name .. " - " .. contact.email)
end

get_contact

Get details of a specific contact in Actively.

Parameters

Name	Type	Required	Description
`org_id`	string	yes	The organization UUID
`contact_id`	string	yes	The contact UUID

Example

local contact = app.integrations.actively.get_contact({
  org_id = "org_abc123",
  contact_id = "cont_def456"
})

print(contact.name)
print("Email: " .. contact.email)
print("Phone: " .. (contact.phone or "N/A"))

Multi-Account Usage

If you have multiple Actively accounts configured, use account-specific namespaces:

-- Default account (always works)
app.integrations.actively.function_name({...})

-- Explicit default (portable across setups)
app.integrations.actively.default.function_name({...})

-- Named accounts
app.integrations.actively.work.function_name({...})
app.integrations.actively.personal.function_name({...})

All functions are identical across accounts — only the credentials differ.

Raw agent markdown

# Actively CRM — Lua API Reference

## list_organizations

List organizations you have access to in Actively.

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `limit` | integer | no | Max organizations to return (default: 25) |
| `page` | integer | no | Page number for pagination (default: 1) |

### Example

```lua
local result = app.integrations.actively.list_organizations({
  limit = 10,
  page = 1
})

for _, org in ipairs(result.data) do
  print(org.id .. ": " .. org.name)
end
```

---

## get_current_user

Get the authenticated user's profile from Actively.

### Parameters

None.

### Example

```lua
local user = app.integrations.actively.get_current_user({})
print("Logged in as: " .. user.name .. " (" .. user.email .. ")")
```

---

## list_campaigns

List campaigns for an organization in Actively.

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `org_id` | string | yes | The organization UUID |
| `limit` | integer | no | Max campaigns to return (default: 25) |
| `page` | integer | no | Page number for pagination (default: 1) |

### Example

```lua
local result = app.integrations.actively.list_campaigns({
  org_id = "org_abc123",
  limit = 10,
  page = 1
})

for _, campaign in ipairs(result.data) do
  print(campaign.title .. " (" .. campaign.type .. ") - " .. campaign.status)
end
```

---

## get_campaign

Get details of a specific campaign in Actively.

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `org_id` | string | yes | The organization UUID |
| `campaign_id` | string | yes | The campaign UUID |

### Example

```lua
local campaign = app.integrations.actively.get_campaign({
  org_id = "org_abc123",
  campaign_id = "camp_xyz789"
})

print(campaign.title)
print("Type: " .. campaign.type)
print("Period: " .. campaign.start_date .. " to " .. campaign.end_date)
```

---

## create_campaign

Create a new campaign for an organization in Actively.

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `org_id` | string | yes | The organization UUID |
| `title` | string | yes | The campaign title |
| `type` | string | yes | Campaign type (e.g., `"email"`, `"social"`, `"ads"`) |
| `start_date` | string | yes | Start date in ISO 8601 format (e.g., `"2026-01-01"`) |
| `end_date` | string | yes | End date in ISO 8601 format (e.g., `"2026-03-31"`) |

### Example

```lua
local campaign = app.integrations.actively.create_campaign({
  org_id = "org_abc123",
  title = "Q1 Product Launch",
  type = "email",
  start_date = "2026-01-15",
  end_date = "2026-03-31"
})

print("Created campaign: " .. campaign.id)
```

---

## list_contacts

List contacts for an organization in Actively.

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `org_id` | string | yes | The organization UUID |
| `limit` | integer | no | Max contacts to return (default: 25) |
| `page` | integer | no | Page number for pagination (default: 1) |

### Example

```lua
local result = app.integrations.actively.list_contacts({
  org_id = "org_abc123",
  limit = 50,
  page = 1
})

for _, contact in ipairs(result.data) do
  print(contact.name .. " - " .. contact.email)
end
```

---

## get_contact

Get details of a specific contact in Actively.

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `org_id` | string | yes | The organization UUID |
| `contact_id` | string | yes | The contact UUID |

### Example

```lua
local contact = app.integrations.actively.get_contact({
  org_id = "org_abc123",
  contact_id = "cont_def456"
})

print(contact.name)
print("Email: " .. contact.email)
print("Phone: " .. (contact.phone or "N/A"))
```

---

## Multi-Account Usage

If you have multiple Actively accounts configured, use account-specific namespaces:

```lua
-- Default account (always works)
app.integrations.actively.function_name({...})

-- Explicit default (portable across setups)
app.integrations.actively.default.function_name({...})

-- Named accounts
app.integrations.actively.work.function_name({...})
app.integrations.actively.personal.function_name({...})
```

All functions are identical across accounts — only the credentials differ.

Metadata-Derived Lua Example

local result = app.integrations.actively.actively_list_organizations({
  limit = 1,
  page = 1
})
print(result)

Functions

`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
Full name: actively.actively_list_organizations

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_get_current_user`

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

Operation: Read read
Full name: actively.actively_get_current_user

Parameter	Type	Required	Description
No parameters.

`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
Full name: actively.actively_list_campaigns

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_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
Full name: actively.actively_get_campaign

Parameter	Type	Required	Description
`org_id`	string	yes	The organization UUID.
`campaign_id`	string	yes	The campaign UUID.

`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
Full name: actively.actively_create_campaign

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_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
Full name: actively.actively_list_contacts

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_get_contact`

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

Operation: Read read
Full name: actively.actively_get_contact

Parameter	Type	Required	Description
`org_id`	string	yes	The organization UUID.
`contact_id`	string	yes	The contact UUID.