Can I use Outreach as a CLI?

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

Can I expose Outreach through MCP?

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

Where are Outreach credentials stored?

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

Can I deny write access for Outreach MCP tools?

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

data

Outreach CLI for AI Agents

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

Outreach CLI Setup

Outreach can be configured headlessly with `kosmokrator integrations:configure outreach`.

Install, configure, and verify

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

Credentials

Authentication type: Manual OAuth token oauth2_manual_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`	`OUTREACH_ACCESS_TOKEN`	Secret `secret`	yes	Access Token
`url`	`OUTREACH_URL`	URL `url`	no	API Base URL

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

Generic CLI call

kosmo integrations:call outreach.outreach_list_prospects '{"page_size":1,"page_number":1,"sort":"example_sort","filter":"example_filter"}' --json

Provider shortcut

kosmo integrations:outreach outreach_list_prospects '{"page_size":1,"page_number":1,"sort":"example_sort","filter":"example_filter"}' --json

Discovery

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

Discovery commands

kosmo integrations:docs outreach --json
kosmo integrations:docs outreach.outreach_list_prospects --json
kosmo integrations:schema outreach.outreach_list_prospects --json
kosmo integrations:search "Outreach" --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.

CI Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status. Cron Jobs Schedule repeatable integration workflows from cron while keeping credentials in KosmoKrator config. Shell Scripts Call integration functions from shell scripts with stable JSON input and output. Headless Automation Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers. Coding Agents Let coding agents discover schemas and execute integration functions through CLI commands or MCP.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

`outreach.outreach_list_prospects`

List prospects in Outreach with optional filtering, sorting, and pagination. Returns prospect records including names, emails, and company info.

Read read

Parameters: page_size, page_number, sort, filter

Generic call

kosmo integrations:call outreach.outreach_list_prospects '{"page_size":1,"page_number":1,"sort":"example_sort","filter":"example_filter"}' --json

Shortcut

kosmo integrations:outreach outreach_list_prospects '{"page_size":1,"page_number":1,"sort":"example_sort","filter":"example_filter"}' --json

`outreach.outreach_get_prospect`

Get a single prospect from Outreach by ID. Returns full prospect details including contact info, custom fields, and related data.

Read read

Parameters: id

Generic call

kosmo integrations:call outreach.outreach_get_prospect '{"id":1}' --json

Shortcut

kosmo integrations:outreach outreach_get_prospect '{"id":1}' --json

`outreach.outreach_create_prospect`

Create a new prospect in Outreach. Provide first name, last name, emails, and optional company to add a contact to your prospect database.

Write write

Parameters: first_name, last_name, emails, company

Generic call

kosmo integrations:call outreach.outreach_create_prospect '{"first_name":"example_first_name","last_name":"example_last_name","emails":"example_emails","company":"example_company"}' --json

Shortcut

kosmo integrations:outreach outreach_create_prospect '{"first_name":"example_first_name","last_name":"example_last_name","emails":"example_emails","company":"example_company"}' --json

`outreach.outreach_list_sequences`

List sales sequences in Outreach with optional pagination. Returns sequence details including name, status, and creation date.

Read read

Parameters: page_size, page_number

Generic call

kosmo integrations:call outreach.outreach_list_sequences '{"page_size":1,"page_number":1}' --json

Shortcut

kosmo integrations:outreach outreach_list_sequences '{"page_size":1,"page_number":1}' --json

`outreach.outreach_get_sequence`

Get a single sales sequence from Outreach by ID. Returns full sequence details including steps, settings, and associated metadata.

Read read

Parameters: id

Generic call

kosmo integrations:call outreach.outreach_get_sequence '{"id":1}' --json

Shortcut

kosmo integrations:outreach outreach_get_sequence '{"id":1}' --json

`outreach.outreach_list_accounts`

List accounts (organizations) in Outreach with optional pagination. Returns account details including name, domain, and company information.

Read read

Parameters: page_size, page_number

Generic call

kosmo integrations:call outreach.outreach_list_accounts '{"page_size":1,"page_number":1}' --json

Shortcut

kosmo integrations:outreach outreach_list_accounts '{"page_size":1,"page_number":1}' --json

`outreach.outreach_get_current_user`

Get the currently authenticated Outreach user. Returns user profile details including name, email, and role.

Read read

Parameters: none

Generic call

kosmo integrations:call outreach.outreach_get_current_user '{}' --json

Shortcut

kosmo integrations:outreach outreach_get_current_user '{}' --json

Function Schemas

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

outreach.outreach_list_prospects 4 parameters

Schema command

kosmo integrations:schema outreach.outreach_list_prospects --json

Parameter	Type	Required	Description
`page_size`	integer	no	Number of prospects to return per page (default: 25, max: 100).
`page_number`	integer	no	Page number to retrieve (1-based).
`sort`	string	no	Sort field and direction (e.g., "createdAt" or "-createdAt" for descending).
`filter`	array	no	JSON:API filter parameters (e.g., {"email": "user@example.com"}).

outreach.outreach_get_prospect 1 parameters

Schema command

kosmo integrations:schema outreach.outreach_get_prospect --json

Parameter	Type	Required	Description
`id`	integer	yes	The prospect ID.

outreach.outreach_create_prospect 4 parameters

Schema command

kosmo integrations:schema outreach.outreach_create_prospect --json

Parameter	Type	Required	Description
`first_name`	string	no	The prospect's first name.
`last_name`	string	no	The prospect's last name.
`emails`	array	no	Array of email addresses for the prospect (e.g., ["user@example.com"]).
`company`	string	no	The prospect's company name.

outreach.outreach_list_sequences 2 parameters

Schema command

kosmo integrations:schema outreach.outreach_list_sequences --json

Parameter	Type	Required	Description
`page_size`	integer	no	Number of sequences to return per page (default: 25, max: 100).
`page_number`	integer	no	Page number to retrieve (1-based).

outreach.outreach_get_sequence 1 parameters

Schema command

kosmo integrations:schema outreach.outreach_get_sequence --json

Parameter	Type	Required	Description
`id`	integer	yes	The sequence ID.

outreach.outreach_list_accounts 2 parameters

Schema command

kosmo integrations:schema outreach.outreach_list_accounts --json

Parameter	Type	Required	Description
`page_size`	integer	no	Number of accounts to return per page (default: 25, max: 100).
`page_number`	integer	no	Page number to retrieve (1-based).

outreach.outreach_get_current_user 0 parameters

Schema command

kosmo integrations:schema outreach.outreach_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.