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.

other

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.

7 functions 6 read 1 write Manual OAuth token auth

Submit Outreach feedback View package source

Outreach CLI Setup

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

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

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

Call Outreach Headlessly

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

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

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

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

Agent Discovery Commands

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

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

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

`outreach.outreach_list_prospects`

Read read

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

Parameters: page_size, page_number, sort, filter

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

`outreach.outreach_get_prospect`

Read read

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

Parameters: id

Generic CLI call

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

Provider shortcut

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

`outreach.outreach_create_prospect`

Write write

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

Parameters: first_name, last_name, emails, company

Generic CLI 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

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

Read read

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

Parameters: page_size, page_number

Generic CLI call

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

Provider shortcut

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

`outreach.outreach_get_sequence`

Read read

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

Parameters: id

Generic CLI call

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

Provider shortcut

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

`outreach.outreach_list_accounts`

Read read

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

Parameters: page_size, page_number

Generic CLI call

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

Provider shortcut

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

`outreach.outreach_get_current_user`

Read read

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

Parameters: none

Generic CLI call

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

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

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

Operation: Read read
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": "[email protected]"}).

`outreach.outreach_get_prospect`

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

Operation: Read read
Schema command: kosmo integrations:schema outreach.outreach_get_prospect --json

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

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

Operation: Write write
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., ["[email protected]"]).
`company`	string	no	The prospect's company name.

`outreach.outreach_list_sequences`

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

Operation: Read read
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`

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

Operation: Read read
Schema command: kosmo integrations:schema outreach.outreach_get_sequence --json

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

`outreach.outreach_list_accounts`

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

Operation: Read read
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`

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

Operation: Read read
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.