crm
Close CRM CLI for CI
Use the Close CRM CLI for CI with headless JSON commands, schema discovery, credentials, and permission controls.
9 functions 5 read 4 write API key auth
Close CRM CLI for CI
Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status.
Use this shape when a pipeline needs to read or update an external service. The Close CRM CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.
Command Shape
# Close CRM CLI for CI
kosmokrator integrations:configure close --set api_key="$CLOSE_API_KEY" --enable --read allow --write ask --json
kosmo integrations:call close.close_list_leads '{"query":"example_query","limit":1,"skip":1}' --json Discovery Before Execution
Agents and scripts can inspect Close CRM docs and schemas 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 Useful Close CRM CLI Functions
| Function | Type | Parameters | Description |
|---|---|---|---|
close.close_list_leads | Read | query, limit, skip | 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. |
close.close_get_lead | Read | id | Get full details for a single lead in Close CRM, including contacts, addresses, custom fields, and associated information. |
close.close_create_lead | Write | name, contacts, url, status_id, custom | Create a new lead in Close CRM. Provide a company name and optionally add contacts with email addresses and phone numbers. |
close.close_update_lead | Write | id, name, status_id, url, custom | Update an existing lead in Close CRM. Provide the lead ID and the fields to update (name, status, custom fields, URL, etc.). |
close.close_delete_lead | Write | id | Permanently delete a lead from Close CRM. This removes the lead and all associated contacts, activities, and tasks. |
close.close_list_contacts | Read | lead_id, limit, skip | List contacts in Close CRM. Optionally filter by lead ID to get contacts for a specific lead. Supports pagination. |
close.close_list_activities | Read | lead_id, type, limit, skip | List activities in Close CRM — emails, calls, notes, and other activity types. Filter by lead ID or activity type. Supports pagination. |
close.close_create_task | Write | text, lead_id, assignee_id, due_date, is_complete | Create a new task in Close CRM. Optionally associate it with a lead, assign it to a user, and set a due date. |
close.close_get_current_user | Read | none | Get the profile of the currently authenticated Close CRM user — name, email, organization, and other account details. |
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.