Can I use Freshworks CRM as a CLI?

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

Can I expose Freshworks CRM through MCP?

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

Where are Freshworks CRM credentials stored?

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

Can I deny write access for Freshworks CRM MCP tools?

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

sales

Freshworks CRM CLI for AI Agents

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

7 functions 6 read 1 write API key auth

Submit Freshworks CRM feedback View package source

Freshworks CRM CLI Setup

Freshworks CRM can be configured headlessly with `kosmokrator integrations:configure freshworks_crm`.

# 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 freshworks_crm --set api_key="$FRESHWORKS_CRM_API_KEY" --set domain="$FRESHWORKS_CRM_DOMAIN" --enable --read allow --write ask --json
kosmokrator integrations:doctor freshworks_crm --json
kosmokrator integrations:status --json

Credentials

Authentication type: API key api_key. 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
`api_key`	`FRESHWORKS_CRM_API_KEY`	Secret `secret`	yes	API Key
`domain`	`FRESHWORKS_CRM_DOMAIN`	Text `string`	yes	Domain

Call Freshworks CRM Headlessly

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

kosmo integrations:call freshworks_crm.freshworks_crm_list_contacts '{
  "page": 1,
  "per_page": 1
}' --json

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

kosmo integrations:freshworks_crm freshworks_crm_list_contacts '{
  "page": 1,
  "per_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 freshworks_crm --json
kosmo integrations:docs freshworks_crm.freshworks_crm_list_contacts --json
kosmo integrations:schema freshworks_crm.freshworks_crm_list_contacts --json
kosmo integrations:search "Freshworks CRM" --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 Freshworks CRM.

`freshworks_crm.freshworks_crm_list_contacts`

Read read

List contacts in Freshworks CRM. Returns paginated results with contact details including name, email, phone, and company.

Parameters: page, per_page

Generic CLI call

kosmo integrations:call freshworks_crm.freshworks_crm_list_contacts '{"page":1,"per_page":1}' --json

Provider shortcut

kosmo integrations:freshworks_crm freshworks_crm_list_contacts '{"page":1,"per_page":1}' --json

`freshworks_crm.freshworks_crm_get_contact`

Read read

Get a single contact from Freshworks CRM by ID. Returns full contact details including custom fields.

Parameters: id

Generic CLI call

kosmo integrations:call freshworks_crm.freshworks_crm_get_contact '{"id":1}' --json

Provider shortcut

kosmo integrations:freshworks_crm freshworks_crm_get_contact '{"id":1}' --json

`freshworks_crm.freshworks_crm_create_contact`

Write write

Create a new contact in Freshworks CRM. Provide at least a first name or last name. Email and mobile number are optional.

Parameters: first_name, last_name, email, mobile_number

Generic CLI call

kosmo integrations:call freshworks_crm.freshworks_crm_create_contact '{"first_name":"example_first_name","last_name":"example_last_name","email":"example_email","mobile_number":"example_mobile_number"}' --json

Provider shortcut

kosmo integrations:freshworks_crm freshworks_crm_create_contact '{"first_name":"example_first_name","last_name":"example_last_name","email":"example_email","mobile_number":"example_mobile_number"}' --json

`freshworks_crm.freshworks_crm_list_deals`

Read read

List deals in Freshworks CRM. Returns paginated results with deal details. Optionally filter by deal stage.

Parameters: page, per_page, stage

Generic CLI call

kosmo integrations:call freshworks_crm.freshworks_crm_list_deals '{"page":1,"per_page":1,"stage":1}' --json

Provider shortcut

kosmo integrations:freshworks_crm freshworks_crm_list_deals '{"page":1,"per_page":1,"stage":1}' --json

`freshworks_crm.freshworks_crm_get_deal`

Read read

Get a single deal from Freshworks CRM by ID. Returns full deal details including amount, stage, associated contacts, and custom fields.

Parameters: id

Generic CLI call

kosmo integrations:call freshworks_crm.freshworks_crm_get_deal '{"id":1}' --json

Provider shortcut

kosmo integrations:freshworks_crm freshworks_crm_get_deal '{"id":1}' --json

`freshworks_crm.freshworks_crm_list_accounts`

Read read

List sales accounts in Freshworks CRM. Returns paginated results with account details including name, domain, and industry.

Parameters: page, per_page

Generic CLI call

kosmo integrations:call freshworks_crm.freshworks_crm_list_accounts '{"page":1,"per_page":1}' --json

Provider shortcut

kosmo integrations:freshworks_crm freshworks_crm_list_accounts '{"page":1,"per_page":1}' --json

`freshworks_crm.freshworks_crm_get_current_user`

Read read

Get the currently authenticated Freshworks CRM user. Useful for verifying credentials and understanding whose context the agent is operating in.

Parameters: none

Generic CLI call

kosmo integrations:call freshworks_crm.freshworks_crm_get_current_user '{}' --json

Provider shortcut

kosmo integrations:freshworks_crm freshworks_crm_get_current_user '{}' --json

Function Schemas

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

`freshworks_crm.freshworks_crm_list_contacts`

List contacts in Freshworks CRM. Returns paginated results with contact details including name, email, phone, and company.

Operation: Read read
Schema command: kosmo integrations:schema freshworks_crm.freshworks_crm_list_contacts --json

Parameter	Type	Required	Description
`page`	integer	no	Page number for pagination (default: 1).
`per_page`	integer	no	Number of contacts per page (default: 20, max: 100).

`freshworks_crm.freshworks_crm_get_contact`

Get a single contact from Freshworks CRM by ID. Returns full contact details including custom fields.

Operation: Read read
Schema command: kosmo integrations:schema freshworks_crm.freshworks_crm_get_contact --json

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

`freshworks_crm.freshworks_crm_create_contact`

Create a new contact in Freshworks CRM. Provide at least a first name or last name. Email and mobile number are optional.

Operation: Write write
Schema command: kosmo integrations:schema freshworks_crm.freshworks_crm_create_contact --json

Parameter	Type	Required	Description
`first_name`	string	no	First name of the contact.
`last_name`	string	no	Last name of the contact.
`email`	string	no	Email address of the contact.
`mobile_number`	string	no	Mobile phone number of the contact.

`freshworks_crm.freshworks_crm_list_deals`

List deals in Freshworks CRM. Returns paginated results with deal details. Optionally filter by deal stage.

Operation: Read read
Schema command: kosmo integrations:schema freshworks_crm.freshworks_crm_list_deals --json

Parameter	Type	Required	Description
`page`	integer	no	Page number for pagination (default: 1).
`per_page`	integer	no	Number of deals per page (default: 20, max: 100).
`stage`	integer	no	Filter deals by stage ID (e.g., pipeline stage).

`freshworks_crm.freshworks_crm_get_deal`

Get a single deal from Freshworks CRM by ID. Returns full deal details including amount, stage, associated contacts, and custom fields.

Operation: Read read
Schema command: kosmo integrations:schema freshworks_crm.freshworks_crm_get_deal --json

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

`freshworks_crm.freshworks_crm_list_accounts`

List sales accounts in Freshworks CRM. Returns paginated results with account details including name, domain, and industry.

Operation: Read read
Schema command: kosmo integrations:schema freshworks_crm.freshworks_crm_list_accounts --json

Parameter	Type	Required	Description
`page`	integer	no	Page number for pagination (default: 1).
`per_page`	integer	no	Number of accounts per page (default: 20, max: 100).

`freshworks_crm.freshworks_crm_get_current_user`

Get the currently authenticated Freshworks CRM user. Useful for verifying credentials and understanding whose context the agent is operating in.

Operation: Read read
Schema command: kosmo integrations:schema freshworks_crm.freshworks_crm_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.