KosmoKrator

productivity

Pipedrive CLI for AI Agents

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

7 functions 6 read 1 write API token auth

Pipedrive CLI Setup

Pipedrive can be configured headlessly with `kosmokrator integrations:configure pipedrive`.

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

Credentials

Authentication type: API token api_token. Configure credentials once, then use the same stored profile from scripts, coding CLIs, Lua code mode, and the MCP gateway.

KeyEnv varTypeRequiredLabel
api_token PIPEDRIVE_API_TOKEN Secret secret yes API Token
url PIPEDRIVE_URL URL url no API Base URL

Call Pipedrive Headlessly

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

kosmo integrations:call pipedrive.pipedrive_create_deal '{
  "title": "example_title",
  "value": 1,
  "currency": "example_currency",
  "person_id": 1,
  "org_id": 1,
  "stage_id": 1,
  "pipeline_id": 1,
  "status": "example_status"
}' --json

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

kosmo integrations:pipedrive pipedrive_create_deal '{
  "title": "example_title",
  "value": 1,
  "currency": "example_currency",
  "person_id": 1,
  "org_id": 1,
  "stage_id": 1,
  "pipeline_id": 1,
  "status": "example_status"
}' --json

Agent Discovery Commands

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

kosmo integrations:docs pipedrive --json
kosmo integrations:docs pipedrive.pipedrive_create_deal --json
kosmo integrations:schema pipedrive.pipedrive_create_deal --json
kosmo integrations:search "Pipedrive" --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 Pipedrive.

pipedrive.pipedrive_create_deal

Write write

Create a new deal in Pipedrive. Provide a title and optionally set value, currency, person, organization, stage, and other deal fields.

Parameters
title, value, currency, person_id, org_id, stage_id, pipeline_id, status, probability, note

Generic CLI call

kosmo integrations:call pipedrive.pipedrive_create_deal '{"title":"example_title","value":1,"currency":"example_currency","person_id":1,"org_id":1,"stage_id":1,"pipeline_id":1,"status":"example_status"}' --json

Provider shortcut

kosmo integrations:pipedrive pipedrive_create_deal '{"title":"example_title","value":1,"currency":"example_currency","person_id":1,"org_id":1,"stage_id":1,"pipeline_id":1,"status":"example_status"}' --json

pipedrive.pipedrive_get_current_user

Read read

Get the profile of the currently authenticated Pipedrive user — name, email, company, timezone, and other account details.

Parameters
none

Generic CLI call

kosmo integrations:call pipedrive.pipedrive_get_current_user '{}' --json

Provider shortcut

kosmo integrations:pipedrive pipedrive_get_current_user '{}' --json

pipedrive.pipedrive_get_deal

Read read

Get full details for a single deal in Pipedrive, including value, stage, person, organization, and custom fields.

Parameters
id

Generic CLI call

kosmo integrations:call pipedrive.pipedrive_get_deal '{"id":1}' --json

Provider shortcut

kosmo integrations:pipedrive pipedrive_get_deal '{"id":1}' --json

pipedrive.pipedrive_get_person

Read read

Get full details for a single person (contact) in Pipedrive, including email, phone, organization, and custom fields.

Parameters
id

Generic CLI call

kosmo integrations:call pipedrive.pipedrive_get_person '{"id":1}' --json

Provider shortcut

kosmo integrations:pipedrive pipedrive_get_person '{"id":1}' --json

pipedrive.pipedrive_list_deals

Read read

List deals in Pipedrive with optional filters for user, person, organization, and status. Returns a paginated list of deals with key details.

Parameters
user_id, person_id, org_id, status, limit, start

Generic CLI call

kosmo integrations:call pipedrive.pipedrive_list_deals '{"user_id":1,"person_id":1,"org_id":1,"status":"example_status","limit":1,"start":1}' --json

Provider shortcut

kosmo integrations:pipedrive pipedrive_list_deals '{"user_id":1,"person_id":1,"org_id":1,"status":"example_status","limit":1,"start":1}' --json

pipedrive.pipedrive_list_organizations

Read read

List organizations in Pipedrive. Returns a paginated list with name, address, owner, and other details.

Parameters
limit, start

Generic CLI call

kosmo integrations:call pipedrive.pipedrive_list_organizations '{"limit":1,"start":1}' --json

Provider shortcut

kosmo integrations:pipedrive pipedrive_list_organizations '{"limit":1,"start":1}' --json

pipedrive.pipedrive_list_persons

Read read

List persons (contacts) in Pipedrive. Returns a paginated list with name, email, phone, organization, and owner details.

Parameters
limit, start

Generic CLI call

kosmo integrations:call pipedrive.pipedrive_list_persons '{"limit":1,"start":1}' --json

Provider shortcut

kosmo integrations:pipedrive pipedrive_list_persons '{"limit":1,"start":1}' --json

Function Schemas

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

pipedrive.pipedrive_create_deal

Create a new deal in Pipedrive. Provide a title and optionally set value, currency, person, organization, stage, and other deal fields.

Operation
Write write
Schema command
kosmo integrations:schema pipedrive.pipedrive_create_deal --json
ParameterTypeRequiredDescription
title string yes The deal title.
value number no The deal value (numeric).
currency string no Deal currency code (e.g., "USD", "EUR").
person_id integer no ID of the person associated with this deal.
org_id integer no ID of the organization associated with this deal.
stage_id integer no ID of the pipeline stage to place the deal in.
pipeline_id integer no ID of the pipeline. Omit for the default pipeline.
status string no Deal status: "open" (default), "won", or "lost".
probability number no Deal success probability (0–100).
note string no Note to attach to the deal.

pipedrive.pipedrive_get_current_user

Get the profile of the currently authenticated Pipedrive user — name, email, company, timezone, and other account details.

Operation
Read read
Schema command
kosmo integrations:schema pipedrive.pipedrive_get_current_user --json
ParameterTypeRequiredDescription
No parameters.

pipedrive.pipedrive_get_deal

Get full details for a single deal in Pipedrive, including value, stage, person, organization, and custom fields.

Operation
Read read
Schema command
kosmo integrations:schema pipedrive.pipedrive_get_deal --json
ParameterTypeRequiredDescription
id integer yes The deal ID.

pipedrive.pipedrive_get_person

Get full details for a single person (contact) in Pipedrive, including email, phone, organization, and custom fields.

Operation
Read read
Schema command
kosmo integrations:schema pipedrive.pipedrive_get_person --json
ParameterTypeRequiredDescription
id integer yes The person ID.

pipedrive.pipedrive_list_deals

List deals in Pipedrive with optional filters for user, person, organization, and status. Returns a paginated list of deals with key details.

Operation
Read read
Schema command
kosmo integrations:schema pipedrive.pipedrive_list_deals --json
ParameterTypeRequiredDescription
user_id integer no Filter deals by user ID (the user the deal is assigned to).
person_id integer no Filter deals by person ID.
org_id integer no Filter deals by organization ID.
status string no Filter by status: "open", "won", "lost", or "deleted". Omit to return all.
limit integer no Maximum number of deals to return (default: 25, max: 500).
start integer no Pagination start offset (0-based).

pipedrive.pipedrive_list_organizations

List organizations in Pipedrive. Returns a paginated list with name, address, owner, and other details.

Operation
Read read
Schema command
kosmo integrations:schema pipedrive.pipedrive_list_organizations --json
ParameterTypeRequiredDescription
limit integer no Maximum number of organizations to return (default: 25, max: 500).
start integer no Pagination start offset (0-based).

pipedrive.pipedrive_list_persons

List persons (contacts) in Pipedrive. Returns a paginated list with name, email, phone, organization, and owner details.

Operation
Read read
Schema command
kosmo integrations:schema pipedrive.pipedrive_list_persons --json
ParameterTypeRequiredDescription
limit integer no Maximum number of persons to return (default: 25, max: 500).
start integer no Pagination start offset (0-based).

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.