canonical: https://jentic.com/apis/pipelinedeals.com/pipelinedeals

# PipelineDeals API

PipelineDeals is a sales CRM focused on relationship-driven selling with visual pipeline management, contact tracking, activity logging, and deal forecasting. The API provides access to deals, people, companies, activities, custom fields, calendar events, and reporting data. Built for sales teams, integration platforms, and AI agents that need to automate lead management, track sales activities, and forecast revenue across customizable deal pipelines.

## For AI agents

Manage sales deals, contacts, companies, activities, and custom pipelines in PipelineDeals CRM. Supports 50 endpoints covering the full sales cycle from lead to close.

## Scope

Does not handle email marketing, customer support tickets, or billing - use for sales pipeline management, contact tracking, and activity logging only.

## Capabilities

- Create and move deals through custom pipeline stages with monetary values and close dates
- Manage people and company contacts with custom fields, tags, and relationship hierarchies
- Log activities including calls, meetings, emails, and tasks with time tracking and reminders
- Configure custom fields and data structures for deals, people, and companies
- Track deal history, stage changes, and activity timelines for audit and reporting
- Generate sales forecasts and pipeline reports by owner, stage, and time period
- Sync calendar events and tasks with CRM activities for unified scheduling

## Use cases

### AI-Powered Sales Pipeline Automation

Enable AI agents to automate deal progression, activity logging, and contact enrichment without manual CRM data entry. Agents discover deal and activity endpoints via Jentic's intent search, create deals from inbound leads, log follow-up activities, update deal stages based on customer interactions, and generate pipeline reports - all programmatically in real time.

Example prompt: Create a new deal titled 'Enterprise Plan - Acme Corp' with value $75,000 and close date 30 days out, associate with existing company 'Acme Corp', log an initial discovery call activity, and set a follow-up task for next week

### Lead-to-Deal Conversion Tracking

Track the complete journey from lead capture to deal closure with detailed activity history and stage progression. The API provides deal history endpoints showing all status changes, activity logs, and field updates with timestamps and user attribution. Sales operations teams can analyze conversion rates, time-in-stage metrics, and identify bottlenecks in the sales process.

Example prompt: Retrieve all deals created in the last quarter, for each deal fetch complete history of stage changes and activities, calculate average time spent in each stage, and identify deals stuck in 'Proposal' stage for more than 14 days

### Contact and Company Relationship Management

Manage person contacts and company accounts with hierarchical relationships, custom fields, and tags. The API supports creating people with company associations, updating contact details, and querying by custom field values. Integration with enrichment services can automatically populate contact data, company information, and social profiles.

Example prompt: Search for a person by email 'jane@acme.com', if found update their phone and title, if not found create new person and associate with company 'Acme Corp' (creating company if needed), then tag person with 'Decision Maker'

### Sales Activity Logging and Task Management

Automate activity logging and task creation based on customer interactions captured in email, calendar, or communication platforms. The API supports creating activities of various types (call, meeting, email, task) with descriptions, duration, and associations to deals or people. Tasks can include due dates, reminders, and completion tracking.

Example prompt: When a customer meeting is detected in calendar, create an activity of type 'meeting' in PipelineDeals associated with their deal, log meeting notes, and automatically create a follow-up task for 2 days later with reminder

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /api/v3/deals.json | Create a new deal |
| GET | /api/v3/deals.json | List deals with filtering |
| PUT | /api/v3/deals/{id}.json | Update deal stage, value, or custom fields |
| POST | /api/v3/people.json | Create a new person contact |
| POST | /api/v3/companies.json | Create a new company |
| POST | /api/v3/activities.json | Log a sales activity |
| GET | /api/v3/deals/{id}/history.json | Get deal change history |

## Key resources

- **Deals** — Create, update, and track deals through pipeline stages with values and close dates
- **People** — Manage person contacts with custom fields, tags, and company relationships
- **Companies** — Track company accounts with hierarchical relationships to people
- **Activities** — Log sales activities including calls, meetings, emails, and tasks
- **Custom Fields** — Define and manage custom data fields for deals, people, and companies
- **Pipelines** — Configure custom sales pipelines with stages and probabilities
- **Calendar Events** — Sync calendar events with CRM activities

## Why Jentic

- **Setup:** Wiring PipelineDeals by hand means managing its API key, paging through deals, people, and companies, and handling retries yourself. Through Jentic you install once, import PipelineDeals from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** You limit the agent to the operations it needs, such as creating a deal, adding a person, or logging an activity. Because you choose the allowed operations, updating a deal stays out of scope unless you add it.
- **Credential handling:** Your PipelineDeals API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a deal in PipelineDeals' or 'add a company', and Jentic returns the matching PipelineDeals operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Pipedrive API** — Activity-based CRM with visual pipeline management and deal tracking
- **HubSpot CRM Deals** — Full-featured CRM with marketing automation and custom deal pipelines
- **Salesforce Sales Cloud API** — Enterprise CRM platform with extensive customization and ecosystem

## FAQ

### What authentication does the PipelineDeals API use?

The API uses API key authentication passed as the 'api_key' query parameter on every request. API keys are found in Settings > Integrations > API in the PipelineDeals dashboard. Through Jentic, API keys are stored encrypted in the vault and agents receive authenticated requests without the raw key appearing in context.

### Can I move deals between pipeline stages via the API?

Yes. Use PUT /api/v3/deals/{id}.json with the 'deal_stage_id' parameter set to the target stage ID. Stage IDs are retrieved via GET /api/v3/deal_stages.json. When moving stages, you can also update the deal's probability, expected close date, and custom fields in the same request.

### What are the rate limits?

PipelineDeals enforces 120 requests per minute per API key for standard plans. Enterprise plans have higher limits. Rate limit headers (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset) are included in responses. Exceeding limits returns HTTP 429 with retry-after guidance.

### How do custom fields work?

Custom fields are defined at the account level via Settings > Custom Fields or the API. Each field has a unique key that appears in deal, person, or company objects. When creating or updating records via API, include custom field values in the 'custom_fields' object using the field key. Common field types include text, number, date, dropdown, and checkbox.

### Can I log activities from external systems like email?

Yes. POST /api/v3/activities.json creates activities with type (call, email, meeting, task), description, duration, associated deal or person IDs, and completed status. This enables syncing activities from Gmail, Outlook, Slack, or custom communication systems into the CRM activity timeline.

### Is the API available on all plans?

API access is available on all paid PipelineDeals plans (Start, Develop, Grow, Enterprise) starting at $25/user/month. There is no separate API fee. Free trial includes API access for evaluation. Rate limits and feature availability vary by plan tier.

### Can I limit what my agent is allowed to do with the PipelineDeals API?

Yes. Because Jentic One is self-hosted, you decide which PipelineDeals operations your agent may call, so you can allow only what it needs, such as creating a deal, adding a person, or logging an activity. Any operation you do not add stays out of scope, meaning something like updating a deal's stage is unavailable to the agent until you explicitly permit it. Your PipelineDeals API key is held by your own instance and injected at execution time, so the agent never sees the raw key and can only act within the operations you have authorized.