pipedrive-crm-core-openapi
Core Pipedrive CRM API for searching and managing persons, deals, and activities. The user supplies a Pipedrive API token or OAuth credential at connection time; no credential is included. Official documentation: https://developers.pipedrive.com/docs/api/v1
Connect this API to an AI agent Browse all specs
What you can do with pipedrive-crm-core-openapi via MCP
Every endpoint below becomes a governed tool your AI agent (Claude, ChatGPT, or a customer-facing VX agent) can call — with scoped permissions, sandbox testing, and audit logs.
| Method | Path | Operation | Description |
|---|---|---|---|
| GET | /persons |
listPipedrivePersons | List persons |
| POST | /persons |
createPipedrivePerson | Create a person |
| GET | /persons/{person_id} |
getPipedrivePerson | Get a person |
| PATCH | /persons/{person_id} |
updatePipedrivePerson | Update a person |
| DELETE | /persons/{person_id} |
deletePipedrivePerson | Delete a person |
| GET | /persons/search |
searchPipedrivePersons | Search persons |
| GET | /deals |
listPipedriveDeals | List deals |
| POST | /deals |
createPipedriveDeal | Create a deal |
| GET | /deals/{deal_id} |
getPipedriveDeal | Get a deal |
| PATCH | /deals/{deal_id} |
updatePipedriveDeal | Update a deal |
| DELETE | /deals/{deal_id} |
deletePipedriveDeal | Delete a deal |
| GET | /deals/search |
searchPipedriveDeals | Search deals |
| GET | /activities |
listPipedriveActivities | List activities |
| POST | /activities |
createPipedriveActivity | Create an activity |
| GET | /activities/{activity_id} |
getPipedriveActivity | Get an activity |
| PATCH | /activities/{activity_id} |
updatePipedriveActivity | Update an activity |
| DELETE | /activities/{activity_id} |
deletePipedriveActivity | Delete an activity |
Authentication
apiToken
API key — sent as the api_token query parameter
Pipedrive API token supplied by the user through the connection configuration.
Usage guide
Getting credentials
- Create or sign in to a Pipedrive account at Pipedrive.
- For personal testing, open your Pipedrive account settings and copy your API token. For a multi-user integration, configure Pipedrive OAuth.
- When VX Agent asks for authentication, provide the Pipedrive API token through the secure connection configuration. This API uses the
api_tokenquery parameter.
Keep the API token private. Do not paste it into the Swagger file, marketplace description, prompts, or chat messages.
How to use this API
Use this API to search and manage CRM persons, deals, and sales activities. It is useful for lead management, sales pipeline updates, customer follow-up, and account planning.
A typical workflow is:
- Use
GET /persons/searchorGET /deals/searchto find an existing contact or deal. - Use
GET /persons/{person_id}orGET /deals/{deal_id}to inspect the record before changing it. - Use
GET /activitiesto review open or completed follow-up activities. - Use
POST /personsorPOST /dealsto create a record after confirming the required information. - Use
PATCH /persons/{person_id}orPATCH /deals/{deal_id}to update an existing record. - Use
POST /activitiesto create a follow-up activity linked to a person or deal. - Use
DELETEoperations only after the user explicitly confirms the exact record and deletion.
Use limit and start for pagination. Search before creating a contact or deal to reduce duplicates. Do not guess record IDs; use the IDs returned by Pipedrive.
Safety and usage notes
Creating, updating, scheduling, or deleting CRM data changes business records. Ask for confirmation before writing personal data, changing deal value or status, scheduling customer-facing activities, or deleting records.
Use the minimum account permissions required. Do not expose contact emails, phone numbers, deal values, private notes, or API tokens. Use a developer sandbox or test account for initial testing when possible.
A 401 response usually indicates an invalid or missing API token. A 400 response may indicate an invalid date, activity type, relationship ID, or custom field.
Official documentation: Pipedrive API Reference.
How to use this spec
- Create a free VX Agents account (sandbox tools included).
- Open the marketplace and connect “pipedrive-crm-core-openapi” to an agent.
- Expose it as an MCP server for Claude/ChatGPT, or chat with it directly.