Can I use Copper CRM as a CLI?

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

Can I expose Copper CRM through MCP?

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

Where are Copper CRM credentials stored?

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

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

crm

Copper CRM CLI for AI Agents

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

13 functions 8 read 5 write API key auth

Submit Copper CRM feedback View package source

Copper CRM CLI Setup

Copper CRM can be configured headlessly with `kosmokrator integrations:configure copper`.

# 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 copper --set api_key="$COPPER_API_KEY" --set email="$COPPER_EMAIL" --enable --read allow --write ask --json
kosmokrator integrations:doctor copper --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`	`COPPER_API_KEY`	Secret `secret`	yes	API Key
`email`	`COPPER_EMAIL`	email `email`	yes	Account Email

Call Copper CRM Headlessly

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

kosmo integrations:call copper.copper_list_contacts '{
  "page_size": 1,
  "sort_by": "example_sort_by"
}' --json

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

kosmo integrations:copper copper_list_contacts '{
  "page_size": 1,
  "sort_by": "example_sort_by"
}' --json

Agent Discovery Commands

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

kosmo integrations:docs copper --json
kosmo integrations:docs copper.copper_list_contacts --json
kosmo integrations:schema copper.copper_list_contacts --json
kosmo integrations:search "Copper 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 Copper CRM.

`copper.copper_list_contacts`

Read read

Search and list contacts in Copper CRM. Returns contact names, emails, and IDs.

Parameters: page_size, sort_by

Generic CLI call

kosmo integrations:call copper.copper_list_contacts '{"page_size":1,"sort_by":"example_sort_by"}' --json

Provider shortcut

kosmo integrations:copper copper_list_contacts '{"page_size":1,"sort_by":"example_sort_by"}' --json

`copper.copper_get_contact`

Read read

Get details of a specific contact in Copper CRM by ID.

Parameters: id

Generic CLI call

kosmo integrations:call copper.copper_get_contact '{"id":1}' --json

Provider shortcut

kosmo integrations:copper copper_get_contact '{"id":1}' --json

`copper.copper_create_contact`

Write write

Create a new contact in Copper CRM. Provide at least a name.

Parameters: name, email

Generic CLI call

kosmo integrations:call copper.copper_create_contact '{"name":"example_name","email":"example_email"}' --json

Provider shortcut

kosmo integrations:copper copper_create_contact '{"name":"example_name","email":"example_email"}' --json

`copper.copper_update_contact`

Write write

Update an existing contact in Copper CRM. Only the fields provided will be updated.

Parameters: id, name, email

Generic CLI call

kosmo integrations:call copper.copper_update_contact '{"id":1,"name":"example_name","email":"example_email"}' --json

Provider shortcut

kosmo integrations:copper copper_update_contact '{"id":1,"name":"example_name","email":"example_email"}' --json

`copper.copper_delete_contact`

Write write

Delete a contact from Copper CRM. This action cannot be undone.

Parameters: id

Generic CLI call

kosmo integrations:call copper.copper_delete_contact '{"id":1}' --json

Provider shortcut

kosmo integrations:copper copper_delete_contact '{"id":1}' --json

`copper.copper_list_companies`

Read read

Search and list companies in Copper CRM. Returns company names, domains, and IDs.

Parameters: page_size, sort_by

Generic CLI call

kosmo integrations:call copper.copper_list_companies '{"page_size":1,"sort_by":"example_sort_by"}' --json

Provider shortcut

kosmo integrations:copper copper_list_companies '{"page_size":1,"sort_by":"example_sort_by"}' --json

`copper.copper_get_company`

Read read

Get details of a specific company in Copper CRM by ID.

Parameters: id

Generic CLI call

kosmo integrations:call copper.copper_get_company '{"id":1}' --json

Provider shortcut

kosmo integrations:copper copper_get_company '{"id":1}' --json

`copper.copper_create_company`

Write write

Create a new company in Copper CRM.

Parameters: name

Generic CLI call

kosmo integrations:call copper.copper_create_company '{"name":"example_name"}' --json

Provider shortcut

kosmo integrations:copper copper_create_company '{"name":"example_name"}' --json

`copper.copper_list_opportunities`

Read read

Search and list opportunities (deals) in Copper CRM. Returns opportunity names, values, stages, and IDs.

Parameters: page_size, sort_by

Generic CLI call

kosmo integrations:call copper.copper_list_opportunities '{"page_size":1,"sort_by":"example_sort_by"}' --json

Provider shortcut

kosmo integrations:copper copper_list_opportunities '{"page_size":1,"sort_by":"example_sort_by"}' --json

`copper.copper_get_opportunity`

Read read

Get details of a specific opportunity (deal) in Copper CRM by ID.

Parameters: id

Generic CLI call

kosmo integrations:call copper.copper_get_opportunity '{"id":1}' --json

Provider shortcut

kosmo integrations:copper copper_get_opportunity '{"id":1}' --json

`copper.copper_create_opportunity`

Write write

Create a new opportunity (deal) in Copper CRM. Provide a name and pipeline ID. Use copper_list_pipelines first to find available pipeline IDs.

Parameters: name, pipeline_id

Generic CLI call

kosmo integrations:call copper.copper_create_opportunity '{"name":"example_name","pipeline_id":1}' --json

Provider shortcut

kosmo integrations:copper copper_create_opportunity '{"name":"example_name","pipeline_id":1}' --json

`copper.copper_list_pipelines`

Read read

List all sales pipelines in Copper CRM. Each pipeline contains stages that opportunities move through.

Parameters: none

Generic CLI call

kosmo integrations:call copper.copper_list_pipelines '{}' --json

Provider shortcut

kosmo integrations:copper copper_list_pipelines '{}' --json

`copper.copper_get_current_user`

Read read

Get the currently authenticated Copper CRM user. Useful for verifying the connection and account context.

Parameters: none

Generic CLI call

kosmo integrations:call copper.copper_get_current_user '{}' --json

Provider shortcut

kosmo integrations:copper copper_get_current_user '{}' --json

Function Schemas

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

`copper.copper_list_contacts`

Search and list contacts in Copper CRM. Returns contact names, emails, and IDs.

Operation: Read read
Schema command: kosmo integrations:schema copper.copper_list_contacts --json

Parameter	Type	Required	Description
`page_size`	integer	no	Number of contacts to return per page (default: 25, max: 200).
`sort_by`	string	no	Field to sort by (e.g., "name", "created_at").

`copper.copper_get_contact`

Get details of a specific contact in Copper CRM by ID.

Operation: Read read
Schema command: kosmo integrations:schema copper.copper_get_contact --json

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

`copper.copper_create_contact`

Create a new contact in Copper CRM. Provide at least a name.

Operation: Write write
Schema command: kosmo integrations:schema copper.copper_create_contact --json

Parameter	Type	Required	Description
`name`	string	yes	Full name of the contact.
`email`	string	no	Email address of the contact.

`copper.copper_update_contact`

Update an existing contact in Copper CRM. Only the fields provided will be updated.

Operation: Write write
Schema command: kosmo integrations:schema copper.copper_update_contact --json

Parameter	Type	Required	Description
`id`	integer	yes	The Copper contact ID to update.
`name`	string	no	Updated full name of the contact.
`email`	string	no	Updated email address.

`copper.copper_delete_contact`

Delete a contact from Copper CRM. This action cannot be undone.

Operation: Write write
Schema command: kosmo integrations:schema copper.copper_delete_contact --json

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

`copper.copper_list_companies`

Search and list companies in Copper CRM. Returns company names, domains, and IDs.

Operation: Read read
Schema command: kosmo integrations:schema copper.copper_list_companies --json

Parameter	Type	Required	Description
`page_size`	integer	no	Number of companies to return per page (default: 25, max: 200).
`sort_by`	string	no	Field to sort by (e.g., "name", "created_at").

`copper.copper_get_company`

Get details of a specific company in Copper CRM by ID.

Operation: Read read
Schema command: kosmo integrations:schema copper.copper_get_company --json

Parameter	Type	Required	Description
`id`	integer	yes	The Copper company ID.

`copper.copper_create_company`

Create a new company in Copper CRM.

Operation: Write write
Schema command: kosmo integrations:schema copper.copper_create_company --json

Parameter	Type	Required	Description
`name`	string	yes	Company name.

`copper.copper_list_opportunities`

Search and list opportunities (deals) in Copper CRM. Returns opportunity names, values, stages, and IDs.

Operation: Read read
Schema command: kosmo integrations:schema copper.copper_list_opportunities --json

Parameter	Type	Required	Description
`page_size`	integer	no	Number of opportunities to return per page (default: 25, max: 200).
`sort_by`	string	no	Field to sort by (e.g., "name", "created_at").

`copper.copper_get_opportunity`

Get details of a specific opportunity (deal) in Copper CRM by ID.

Operation: Read read
Schema command: kosmo integrations:schema copper.copper_get_opportunity --json

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

`copper.copper_create_opportunity`

Create a new opportunity (deal) in Copper CRM. Provide a name and pipeline ID. Use copper_list_pipelines first to find available pipeline IDs.

Operation: Write write
Schema command: kosmo integrations:schema copper.copper_create_opportunity --json

Parameter	Type	Required	Description
`name`	string	yes	Opportunity name.
`pipeline_id`	integer	yes	ID of the pipeline to create the opportunity in. Use copper_list_pipelines to find available IDs.

`copper.copper_list_pipelines`

List all sales pipelines in Copper CRM. Each pipeline contains stages that opportunities move through.

Operation: Read read
Schema command: kosmo integrations:schema copper.copper_list_pipelines --json

Parameter	Type	Required	Description
No parameters.

`copper.copper_get_current_user`

Get the currently authenticated Copper CRM user. Useful for verifying the connection and account context.

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