Can I use Insightly CRM as a CLI?

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

Can I expose Insightly CRM through MCP?

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

Where are Insightly CRM credentials stored?

Insightly 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 Insightly CRM MCP tools?

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

sales

Insightly CRM CLI for AI Agents

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

7 functions 6 read 1 write Bearer token auth

Submit Insightly CRM feedback View package source

Insightly CRM CLI Setup

Insightly CRM can be configured headlessly with `kosmokrator integrations:configure insightly`.

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

Credentials

Authentication type: Bearer token bearer_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`	`INSIGHTLY_ACCESS_TOKEN`	Secret `secret`	yes	Access Token
`base_url`	`INSIGHTLY_BASE_URL`	URL `url`	no	API Base URL

Call Insightly CRM Headlessly

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

kosmo integrations:call insightly.insightly_list_contacts '{
  "top": 1,
  "skip": 1,
  "search": "example_search"
}' --json

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

kosmo integrations:insightly insightly_list_contacts '{
  "top": 1,
  "skip": 1,
  "search": "example_search"
}' --json

Agent Discovery Commands

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

kosmo integrations:docs insightly --json
kosmo integrations:docs insightly.insightly_list_contacts --json
kosmo integrations:schema insightly.insightly_list_contacts --json
kosmo integrations:search "Insightly 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 Insightly CRM.

`insightly.insightly_list_contacts`

Read read

List contacts from Insightly CRM. Returns contact records with names, emails, phones, and organization info. Use top/skip for pagination and search to filter by name or email.

Parameters: top, skip, search

Generic CLI call

kosmo integrations:call insightly.insightly_list_contacts '{"top":1,"skip":1,"search":"example_search"}' --json

Provider shortcut

kosmo integrations:insightly insightly_list_contacts '{"top":1,"skip":1,"search":"example_search"}' --json

`insightly.insightly_get_contact`

Read read

Get detailed information about a single Insightly contact by ID. Returns all contact fields including addresses, emails, phones, and linked organizations.

Parameters: id

Generic CLI call

kosmo integrations:call insightly.insightly_get_contact '{"id":1}' --json

Provider shortcut

kosmo integrations:insightly insightly_get_contact '{"id":1}' --json

`insightly.insightly_create_contact`

Write write

Create a new contact in Insightly CRM. Provide contact details such as first name, last name, email, and phone. Returns the created contact with its new ID.

Parameters: first_name, last_name, email, phone

Generic CLI call

kosmo integrations:call insightly.insightly_create_contact '{"first_name":"example_first_name","last_name":"example_last_name","email":"example_email","phone":"example_phone"}' --json

Provider shortcut

kosmo integrations:insightly insightly_create_contact '{"first_name":"example_first_name","last_name":"example_last_name","email":"example_email","phone":"example_phone"}' --json

`insightly.insightly_list_opportunities`

Read read

List opportunities from Insightly CRM. Returns opportunity records with names, amounts, stages, and pipeline info. Use top/skip for pagination and status to filter by opportunity state.

Parameters: top, skip, status

Generic CLI call

kosmo integrations:call insightly.insightly_list_opportunities '{"top":1,"skip":1,"status":"example_status"}' --json

Provider shortcut

kosmo integrations:insightly insightly_list_opportunities '{"top":1,"skip":1,"status":"example_status"}' --json

`insightly.insightly_get_opportunity`

Read read

Get detailed information about a single Insightly opportunity by ID. Returns all opportunity fields including amount, stage, pipeline, and linked contacts.

Parameters: id

Generic CLI call

kosmo integrations:call insightly.insightly_get_opportunity '{"id":1}' --json

Provider shortcut

kosmo integrations:insightly insightly_get_opportunity '{"id":1}' --json

`insightly.insightly_list_projects`

Read read

List projects from Insightly CRM. Returns project records with names, statuses, dates, and linked records. Use top/skip for pagination and status to filter by project state.

Parameters: top, skip, status

Generic CLI call

kosmo integrations:call insightly.insightly_list_projects '{"top":1,"skip":1,"status":"example_status"}' --json

Provider shortcut

kosmo integrations:insightly insightly_list_projects '{"top":1,"skip":1,"status":"example_status"}' --json

`insightly.insightly_get_current_user`

Read read

Get the profile of the currently authenticated Insightly user. Returns user name, email, account info, and timezone settings. Useful for verifying API connectivity.

Parameters: none

Generic CLI call

kosmo integrations:call insightly.insightly_get_current_user '{}' --json

Provider shortcut

kosmo integrations:insightly insightly_get_current_user '{}' --json

Function Schemas

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

`insightly.insightly_list_contacts`

List contacts from Insightly CRM. Returns contact records with names, emails, phones, and organization info. Use top/skip for pagination and search to filter by name or email.

Operation: Read read
Schema command: kosmo integrations:schema insightly.insightly_list_contacts --json

Parameter	Type	Required	Description
`top`	integer	no	Maximum number of contacts to return.
`skip`	integer	no	Number of contacts to skip for pagination.
`search`	string	no	Search term to filter contacts by name or email.

`insightly.insightly_get_contact`

Get detailed information about a single Insightly contact by ID. Returns all contact fields including addresses, emails, phones, and linked organizations.

Operation: Read read
Schema command: kosmo integrations:schema insightly.insightly_get_contact --json

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

`insightly.insightly_create_contact`

Create a new contact in Insightly CRM. Provide contact details such as first name, last name, email, and phone. Returns the created contact with its new ID.

Operation: Write write
Schema command: kosmo integrations:schema insightly.insightly_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	Primary email address.
`phone`	string	no	Primary phone number.

`insightly.insightly_list_opportunities`

List opportunities from Insightly CRM. Returns opportunity records with names, amounts, stages, and pipeline info. Use top/skip for pagination and status to filter by opportunity state.

Operation: Read read
Schema command: kosmo integrations:schema insightly.insightly_list_opportunities --json

Parameter	Type	Required	Description
`top`	integer	no	Maximum number of opportunities to return.
`skip`	integer	no	Number of opportunities to skip for pagination.
`status`	string	no	Filter by opportunity status (e.g., "Open", "Won", "Lost", "Suspended").

`insightly.insightly_get_opportunity`

Get detailed information about a single Insightly opportunity by ID. Returns all opportunity fields including amount, stage, pipeline, and linked contacts.

Operation: Read read
Schema command: kosmo integrations:schema insightly.insightly_get_opportunity --json

Parameter	Type	Required	Description
`id`	integer	yes	The Insightly opportunity ID.

`insightly.insightly_list_projects`

List projects from Insightly CRM. Returns project records with names, statuses, dates, and linked records. Use top/skip for pagination and status to filter by project state.

Operation: Read read
Schema command: kosmo integrations:schema insightly.insightly_list_projects --json

Parameter	Type	Required	Description
`top`	integer	no	Maximum number of projects to return.
`skip`	integer	no	Number of projects to skip for pagination.
`status`	string	no	Filter by project status (e.g., "In Progress", "Completed", "Scheduled").

`insightly.insightly_get_current_user`

Get the profile of the currently authenticated Insightly user. Returns user name, email, account info, and timezone settings. Useful for verifying API connectivity.

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