sales
Freshworks CRM CLI for Headless Automation
Use the Freshworks CRM CLI for headless automation with headless JSON commands, schema discovery, credentials, and permission controls.
7 functions 6 read 1 write API key auth
Freshworks CRM CLI for Headless Automation
Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers.
Use headless automation when another tool needs a stable local command surface. The Freshworks CRM CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.
Command Shape
# Freshworks CRM CLI for Headless Automation
kosmokrator integrations:configure freshworks_crm --set api_key="$FRESHWORKS_CRM_API_KEY" --set domain="$FRESHWORKS_CRM_DOMAIN" --enable --read allow --write ask --json
kosmo integrations:call freshworks_crm.freshworks_crm_list_contacts '{"page":1,"per_page":1}' --json Discovery Before Execution
Agents and scripts can inspect Freshworks CRM docs and schemas 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 Useful Freshworks CRM CLI Functions
| Function | Type | Parameters | Description |
|---|---|---|---|
freshworks_crm.freshworks_crm_list_contacts | Read | page, per_page | List contacts in Freshworks CRM. Returns paginated results with contact details including name, email, phone, and company. |
freshworks_crm.freshworks_crm_get_contact | Read | id | Get a single contact from Freshworks CRM by ID. Returns full contact details including custom fields. |
freshworks_crm.freshworks_crm_create_contact | Write | first_name, last_name, email, mobile_number | Create a new contact in Freshworks CRM. Provide at least a first name or last name. Email and mobile number are optional. |
freshworks_crm.freshworks_crm_list_deals | Read | page, per_page, stage | List deals in Freshworks CRM. Returns paginated results with deal details. Optionally filter by deal stage. |
freshworks_crm.freshworks_crm_get_deal | Read | id | Get a single deal from Freshworks CRM by ID. Returns full deal details including amount, stage, associated contacts, and custom fields. |
freshworks_crm.freshworks_crm_list_accounts | Read | page, per_page | List sales accounts in Freshworks CRM. Returns paginated results with account details including name, domain, and industry. |
freshworks_crm.freshworks_crm_get_current_user | Read | none | Get the currently authenticated Freshworks CRM user. Useful for verifying credentials and understanding whose context the agent is operating in. |
Automation Notes
- Use
--jsonfor machine-readable output. - Keep credentials out of argv by using environment variables or stored KosmoKrator configuration.
- Configure read/write policy before unattended runs; use
--forceonly for trusted automation. - Use the MCP gateway instead when the agent needs dynamic tool discovery inside a conversation.