productivity
Close CRM CLI for AI Agents
Use the Close CRM CLI from KosmoKrator to call Close CRM tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.Close CRM CLI Setup
Close CRM can be configured headlessly with `kosmokrator integrations:configure close`.
# 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 close --set api_key="$CLOSE_API_KEY" --enable --read allow --write ask --json
kosmokrator integrations:doctor close --json
kosmokrator integrations:status --json Credentials
Authentication type: API key api_key. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.
| Key | Env var | Type | Required | Label |
|---|---|---|---|---|
api_key | CLOSE_API_KEY | Secret secret | yes | API Key |
url | CLOSE_URL | URL url | no | API Base URL |
Command Patterns
The generic command is stable across every integration. The provider shortcut is shorter for humans.
kosmo integrations:call close.close_list_leads '{"query":"example_query","limit":1,"skip":1}' --json kosmo integrations:close close_list_leads '{"query":"example_query","limit":1,"skip":1}' --json Discovery
These commands return structured output for coding agents that need to inspect capabilities before choosing a function.
kosmo integrations:docs close --json
kosmo integrations:docs close.close_list_leads --json
kosmo integrations:schema close.close_list_leads --json
kosmo integrations:search "Close CRM" --json
kosmo integrations:list --json Automation Contexts
The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.
CLI Functions
Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.
close.close_list_leads
Search and list leads in Close CRM. Use the query parameter with Close search syntax to filter leads by name, status, custom fields, dates, and more. Returns a paginated list of leads with their contacts and addresses.
read - Parameters
- query, limit, skip
kosmo integrations:call close.close_list_leads '{"query":"example_query","limit":1,"skip":1}' --json kosmo integrations:close close_list_leads '{"query":"example_query","limit":1,"skip":1}' --json close.close_get_lead
Get full details for a single lead in Close CRM, including contacts, addresses, custom fields, and associated information.
read - Parameters
- id
kosmo integrations:call close.close_get_lead '{"id":"example_id"}' --json kosmo integrations:close close_get_lead '{"id":"example_id"}' --json close.close_create_lead
Create a new lead in Close CRM. Provide a company name and optionally add contacts with email addresses and phone numbers.
write - Parameters
- name, contacts, url, status_id, custom
kosmo integrations:call close.close_create_lead '{"name":"example_name","contacts":"example_contacts","url":"example_url","status_id":"example_status_id","custom":"example_custom"}' --json kosmo integrations:close close_create_lead '{"name":"example_name","contacts":"example_contacts","url":"example_url","status_id":"example_status_id","custom":"example_custom"}' --json close.close_update_lead
Update an existing lead in Close CRM. Provide the lead ID and the fields to update (name, status, custom fields, URL, etc.).
write - Parameters
- id, name, status_id, url, custom
kosmo integrations:call close.close_update_lead '{"id":"example_id","name":"example_name","status_id":"example_status_id","url":"example_url","custom":"example_custom"}' --json kosmo integrations:close close_update_lead '{"id":"example_id","name":"example_name","status_id":"example_status_id","url":"example_url","custom":"example_custom"}' --json close.close_delete_lead
Permanently delete a lead from Close CRM. This removes the lead and all associated contacts, activities, and tasks.
write - Parameters
- id
kosmo integrations:call close.close_delete_lead '{"id":"example_id"}' --json kosmo integrations:close close_delete_lead '{"id":"example_id"}' --json close.close_list_contacts
List contacts in Close CRM. Optionally filter by lead ID to get contacts for a specific lead. Supports pagination.
read - Parameters
- lead_id, limit, skip
kosmo integrations:call close.close_list_contacts '{"lead_id":"example_lead_id","limit":1,"skip":1}' --json kosmo integrations:close close_list_contacts '{"lead_id":"example_lead_id","limit":1,"skip":1}' --json close.close_get_contact
Get a single contact.
read - Parameters
- none
kosmo integrations:call close.close_get_contact '{}' --json kosmo integrations:close close_get_contact '{}' --json close.close_create_contact
Create a contact on a lead.
write - Parameters
- none
kosmo integrations:call close.close_create_contact '{}' --json kosmo integrations:close close_create_contact '{}' --json close.close_update_contact
Update a contact.
write - Parameters
- none
kosmo integrations:call close.close_update_contact '{}' --json kosmo integrations:close close_update_contact '{}' --json close.close_delete_contact
Delete a contact.
write - Parameters
- none
kosmo integrations:call close.close_delete_contact '{}' --json kosmo integrations:close close_delete_contact '{}' --json close.close_list_opportunities
List or filter opportunities.
read - Parameters
- none
kosmo integrations:call close.close_list_opportunities '{}' --json kosmo integrations:close close_list_opportunities '{}' --json close.close_get_opportunity
Get a single opportunity.
read - Parameters
- none
kosmo integrations:call close.close_get_opportunity '{}' --json kosmo integrations:close close_get_opportunity '{}' --json close.close_create_opportunity
Create an opportunity.
write - Parameters
- none
kosmo integrations:call close.close_create_opportunity '{}' --json kosmo integrations:close close_create_opportunity '{}' --json close.close_update_opportunity
Update an opportunity.
write - Parameters
- none
kosmo integrations:call close.close_update_opportunity '{}' --json kosmo integrations:close close_update_opportunity '{}' --json close.close_delete_opportunity
Delete an opportunity.
write - Parameters
- none
kosmo integrations:call close.close_delete_opportunity '{}' --json kosmo integrations:close close_delete_opportunity '{}' --json close.close_list_tasks
List or filter tasks.
read - Parameters
- none
kosmo integrations:call close.close_list_tasks '{}' --json kosmo integrations:close close_list_tasks '{}' --json close.close_create_task
Create a new task in Close CRM. Optionally associate it with a lead, assign it to a user, and set a due date.
write - Parameters
- text, lead_id, assignee_id, date, due_date, is_complete
kosmo integrations:call close.close_create_task '{"text":"example_text","lead_id":"example_lead_id","assignee_id":"example_assignee_id","date":"example_date","due_date":"example_due_date","is_complete":true}' --json kosmo integrations:close close_create_task '{"text":"example_text","lead_id":"example_lead_id","assignee_id":"example_assignee_id","date":"example_date","due_date":"example_due_date","is_complete":true}' --json close.close_get_task
Get a single task.
read - Parameters
- none
kosmo integrations:call close.close_get_task '{}' --json kosmo integrations:close close_get_task '{}' --json close.close_update_task
Update a task.
write - Parameters
- none
kosmo integrations:call close.close_update_task '{}' --json kosmo integrations:close close_update_task '{}' --json close.close_delete_task
Delete a task.
write - Parameters
- none
kosmo integrations:call close.close_delete_task '{}' --json kosmo integrations:close close_delete_task '{}' --json close.close_list_activities
List activities in Close CRM: emails, calls, notes, and other activity types. Filter by lead ID or activity type. Supports pagination.
read - Parameters
- lead_id, type, limit, skip
kosmo integrations:call close.close_list_activities '{"lead_id":"example_lead_id","type":"example_type","limit":1,"skip":1}' --json kosmo integrations:close close_list_activities '{"lead_id":"example_lead_id","type":"example_type","limit":1,"skip":1}' --json close.close_list_notes
List note activities.
read - Parameters
- none
kosmo integrations:call close.close_list_notes '{}' --json kosmo integrations:close close_list_notes '{}' --json close.close_get_note
Get a note activity.
read - Parameters
- none
kosmo integrations:call close.close_get_note '{}' --json kosmo integrations:close close_get_note '{}' --json close.close_create_note
Create a note activity.
write - Parameters
- none
kosmo integrations:call close.close_create_note '{}' --json kosmo integrations:close close_create_note '{}' --json close.close_update_note
Update a note activity.
write - Parameters
- none
kosmo integrations:call close.close_update_note '{}' --json kosmo integrations:close close_update_note '{}' --json close.close_delete_note
Delete a note activity.
write - Parameters
- none
kosmo integrations:call close.close_delete_note '{}' --json kosmo integrations:close close_delete_note '{}' --json close.close_get_current_user
Get the profile of the currently authenticated Close CRM user: name, email, organization, and other account details.
read - Parameters
- none
kosmo integrations:call close.close_get_current_user '{}' --json kosmo integrations:close close_get_current_user '{}' --json close.close_list_users
List users in the organization.
read - Parameters
- none
kosmo integrations:call close.close_list_users '{}' --json kosmo integrations:close close_list_users '{}' --json close.close_get_user
Get a single user.
read - Parameters
- none
kosmo integrations:call close.close_get_user '{}' --json kosmo integrations:close close_get_user '{}' --json close.close_list_user_availability
List user availability statuses.
read - Parameters
- none
kosmo integrations:call close.close_list_user_availability '{}' --json kosmo integrations:close close_list_user_availability '{}' --json close.close_list_lead_statuses
List configured lead statuses.
read - Parameters
- none
kosmo integrations:call close.close_list_lead_statuses '{}' --json kosmo integrations:close close_list_lead_statuses '{}' --json close.close_create_lead_status
Create a lead status.
write - Parameters
- none
kosmo integrations:call close.close_create_lead_status '{}' --json kosmo integrations:close close_create_lead_status '{}' --json close.close_update_lead_status
Rename a lead status.
write - Parameters
- none
kosmo integrations:call close.close_update_lead_status '{}' --json kosmo integrations:close close_update_lead_status '{}' --json close.close_delete_lead_status
Delete a lead status.
write - Parameters
- none
kosmo integrations:call close.close_delete_lead_status '{}' --json kosmo integrations:close close_delete_lead_status '{}' --json close.close_list_opportunity_statuses
List configured opportunity statuses.
read - Parameters
- none
kosmo integrations:call close.close_list_opportunity_statuses '{}' --json kosmo integrations:close close_list_opportunity_statuses '{}' --json close.close_create_opportunity_status
Create an opportunity status.
write - Parameters
- none
kosmo integrations:call close.close_create_opportunity_status '{}' --json kosmo integrations:close close_create_opportunity_status '{}' --json close.close_update_opportunity_status
Update an opportunity status.
write - Parameters
- none
kosmo integrations:call close.close_update_opportunity_status '{}' --json kosmo integrations:close close_update_opportunity_status '{}' --json close.close_delete_opportunity_status
Delete an opportunity status.
write - Parameters
- none
kosmo integrations:call close.close_delete_opportunity_status '{}' --json kosmo integrations:close close_delete_opportunity_status '{}' --json close.close_list_pipelines
List configured pipelines.
read - Parameters
- none
kosmo integrations:call close.close_list_pipelines '{}' --json kosmo integrations:close close_list_pipelines '{}' --json close.close_create_pipeline
Create a pipeline.
write - Parameters
- none
kosmo integrations:call close.close_create_pipeline '{}' --json kosmo integrations:close close_create_pipeline '{}' --json close.close_update_pipeline
Update a pipeline.
write - Parameters
- none
kosmo integrations:call close.close_update_pipeline '{}' --json kosmo integrations:close close_update_pipeline '{}' --json close.close_delete_pipeline
Delete a pipeline.
write - Parameters
- none
kosmo integrations:call close.close_delete_pipeline '{}' --json kosmo integrations:close close_delete_pipeline '{}' --json Function Schemas
Use these parameter tables when building CLI payloads without calling integrations:schema first.
close.close_list_leads 3 parameters
kosmo integrations:schema close.close_list_leads --json | Parameter | Type | Required | Description |
|---|---|---|---|
query | string | no | Search query using Close syntax. Examples: "Acme", "status:Potential", "name:Acme AND status:Qualified". Omit to list all leads. |
limit | integer | no | Maximum number of leads to return (default: 25, max: 100). |
skip | integer | no | Number of records to skip for pagination. |
close.close_get_lead 1 parameters
kosmo integrations:schema close.close_get_lead --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The lead ID (e.g., "lead_abc123XYZ"). |
close.close_create_lead 5 parameters
kosmo integrations:schema close.close_create_lead --json | Parameter | Type | Required | Description |
|---|---|---|---|
name | string | yes | Company or lead name. |
contacts | array | no | Array of contact objects. Each contact can have "name" (string), "emails" (array of objects with "email" and optional "type"), and "phones" (array of objects with "phone" and optional "type"). |
url | string | no | Company website URL. |
status_id | string | no | Status ID to assign (omit for default status). |
custom | object | no | Custom field values as an object (e.g., {"Industry": "SaaS"}). |
close.close_update_lead 5 parameters
kosmo integrations:schema close.close_update_lead --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The lead ID to update (e.g., "lead_abc123XYZ"). |
name | string | no | New company or lead name. |
status_id | string | no | New status ID to assign. |
url | string | no | New company website URL. |
custom | object | no | Updated custom field values as an object (e.g., {"Industry": "SaaS"}). |
close.close_delete_lead 1 parameters
kosmo integrations:schema close.close_delete_lead --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The lead ID to delete (e.g., "lead_abc123XYZ"). |
close.close_list_contacts 3 parameters
kosmo integrations:schema close.close_list_contacts --json | Parameter | Type | Required | Description |
|---|---|---|---|
lead_id | string | no | Filter contacts by lead ID (e.g., "lead_abc123XYZ"). |
limit | integer | no | Maximum number of contacts to return (default: 25, max: 100). |
skip | integer | no | Number of records to skip for pagination. |
close.close_get_contact 0 parameters
kosmo integrations:schema close.close_get_contact --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_create_contact 0 parameters
kosmo integrations:schema close.close_create_contact --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_update_contact 0 parameters
kosmo integrations:schema close.close_update_contact --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_delete_contact 0 parameters
kosmo integrations:schema close.close_delete_contact --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_list_opportunities 0 parameters
kosmo integrations:schema close.close_list_opportunities --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_get_opportunity 0 parameters
kosmo integrations:schema close.close_get_opportunity --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_create_opportunity 0 parameters
kosmo integrations:schema close.close_create_opportunity --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_update_opportunity 0 parameters
kosmo integrations:schema close.close_update_opportunity --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_delete_opportunity 0 parameters
kosmo integrations:schema close.close_delete_opportunity --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_list_tasks 0 parameters
kosmo integrations:schema close.close_list_tasks --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_create_task 6 parameters
kosmo integrations:schema close.close_create_task --json | Parameter | Type | Required | Description |
|---|---|---|---|
text | string | yes | The task description or body text. |
lead_id | string | no | Associate this task with a lead (e.g., "lead_abc123XYZ"). |
assignee_id | string | no | User ID to assign the task to (e.g., "user_abc123XYZ"). |
date | string | no | Task date in YYYY-MM-DD format (e.g., "2026-04-15"). |
due_date | string | no | Deprecated alias for date, kept for older agents. |
is_complete | boolean | no | Whether the task is already completed (default: false). |
close.close_get_task 0 parameters
kosmo integrations:schema close.close_get_task --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_update_task 0 parameters
kosmo integrations:schema close.close_update_task --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_delete_task 0 parameters
kosmo integrations:schema close.close_delete_task --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_list_activities 4 parameters
kosmo integrations:schema close.close_list_activities --json | Parameter | Type | Required | Description |
|---|---|---|---|
lead_id | string | no | Filter activities by lead ID (e.g., "lead_abc123XYZ"). |
type | string | no | Activity type filter. Common values: "email", "call", "note", "sms", "meeting". |
limit | integer | no | Maximum number of activities to return (default: 25, max: 100). |
skip | integer | no | Number of records to skip for pagination. |
close.close_list_notes 0 parameters
kosmo integrations:schema close.close_list_notes --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_get_note 0 parameters
kosmo integrations:schema close.close_get_note --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_create_note 0 parameters
kosmo integrations:schema close.close_create_note --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_update_note 0 parameters
kosmo integrations:schema close.close_update_note --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_delete_note 0 parameters
kosmo integrations:schema close.close_delete_note --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_get_current_user 0 parameters
kosmo integrations:schema close.close_get_current_user --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_list_users 0 parameters
kosmo integrations:schema close.close_list_users --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_get_user 0 parameters
kosmo integrations:schema close.close_get_user --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_list_user_availability 0 parameters
kosmo integrations:schema close.close_list_user_availability --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_list_lead_statuses 0 parameters
kosmo integrations:schema close.close_list_lead_statuses --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_create_lead_status 0 parameters
kosmo integrations:schema close.close_create_lead_status --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_update_lead_status 0 parameters
kosmo integrations:schema close.close_update_lead_status --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_delete_lead_status 0 parameters
kosmo integrations:schema close.close_delete_lead_status --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_list_opportunity_statuses 0 parameters
kosmo integrations:schema close.close_list_opportunity_statuses --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_create_opportunity_status 0 parameters
kosmo integrations:schema close.close_create_opportunity_status --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_update_opportunity_status 0 parameters
kosmo integrations:schema close.close_update_opportunity_status --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_delete_opportunity_status 0 parameters
kosmo integrations:schema close.close_delete_opportunity_status --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_list_pipelines 0 parameters
kosmo integrations:schema close.close_list_pipelines --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_create_pipeline 0 parameters
kosmo integrations:schema close.close_create_pipeline --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_update_pipeline 0 parameters
kosmo integrations:schema close.close_update_pipeline --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
close.close_delete_pipeline 0 parameters
kosmo integrations:schema close.close_delete_pipeline --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.