Connect AI agents to Pipeline CRM

Scalekit connector

The Pipeline CRM connector lets your AI agent act in each user's Pipeline CRM account. Each user connects their own Pipeline CRM access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 115 tools.

Tools: 115
What they doRead · write · destructive: 74 · 27 · 1474 read27 write14 destructive
Users sign in with: Access token

Setup

Install the SDK
- Node.js
- Python
Terminal window
npm install @scalekit-sdk/node dotenv
Terminal window
pip install scalekit-sdk-python python-dotenv
Set your credentials
Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.
.env
```
SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
SCALEKIT_CLIENT_ID=<your-client-id>
SCALEKIT_CLIENT_SECRET=<your-client-secret>
```
Create the Pipeline CRM connection
In AgentKit > Connections, create a Pipeline CRM connection. The name you give it is the connection_name your code passes. See Configure connections.

Authorize a user and make your first call

Node.js
Python

1
import { ScalekitClient } from '@scalekit-sdk/node'
2
import 'dotenv/config'
3
import { createInterface } from 'node:readline/promises'
4

5
const scalekit = new ScalekitClient(
6
  process.env.SCALEKIT_ENVIRONMENT_URL,
7
  process.env.SCALEKIT_CLIENT_ID,
8
  process.env.SCALEKIT_CLIENT_SECRET,
9
)
10
const actions = scalekit.actions
11

12
const connector = 'pipelinecrm'
13
const identifier = 'user_123'
14

15
// Generate an authorization link for the user
16
const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
17
console.log('Authorize Pipeline CRM:', link)
18
const rl = createInterface({ input: process.stdin, output: process.stdout })
19
await rl.question('Press Enter after authorizing...')
20
rl.close()
21

22
// Make your first call
23
const result = await actions.executeTool({
24
  connector,
25
  identifier,
26
  toolName: 'pipelinecrm_audits_list',
27
  toolInput: {},
28
})
29
console.log(result)

npx tsx quickstart.mts

1
import os
2
from scalekit import ScalekitClient
3
from dotenv import load_dotenv
4
load_dotenv()
5

6
scalekit_client = ScalekitClient(
7
    env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
8
    client_id=os.getenv("SCALEKIT_CLIENT_ID"),
9
    client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
10
)
11
actions = scalekit_client.actions
12

13
connection_name = "pipelinecrm"
14
identifier = "user_123"
15

16
# Generate an authorization link for the user
17
link_response = actions.get_authorization_link(
18
    connection_name=connection_name,
19
    identifier=identifier,
20
)
21
print("Authorize Pipeline CRM:", link_response.link)
22
input("Press Enter after authorizing...")
23

24
# Make your first call
25
result = actions.execute_tool(
26
    tool_input={},
27
    tool_name="pipelinecrm_audits_list",
28
    connection_name=connection_name,
29
    identifier=identifier,
30
)
31
print(result)

python quickstart.py

Each user opens the link once and enters their Pipeline CRM credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool

Try in Playground Request a tool

pipelinecrm_audits_listList the change history of records you can see, optionally filtered by record type and ID, user, change type, field or date.Read-only
List Audits
List the change history of records you can see, optionally filtered by record type and ID, user, change type, field or date. Returns a page of audit entries (id, auditable_type, auditable_id, user_id, audit_type, model_column, value before and after, created_at) plus pagination. Use it to see who changed what on a deal, person or company.
Inputs
added_fromstring
Only return records whose change date is on or after this date (YYYY-MM-DD, user's time zone). Example: 2026-01-01
added_tostring
Only return records whose change date is on or before this date (YYYY-MM-DD, user's time zone). Example: 2026-03-31
audit_typestring
Only return this kind of change, such as create, update or destroy. Example: update
auditable_idsstring
Only return changes to these record IDs. One ID or a comma-separated list. Example: 4521
auditable_typestring
Only return changes to this record type, such as Deal, Person or Company. Example: Deal
model_columnstring
Only return changes to this field name. Example: deal_stage_id
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
sortstring
Sort key, `-` prefix for descending. Example: -created_at
user_idsstring
Only return changes made by these users. One ID or a comma-separated list. Example: 13
pipelinecrm_calendar_entries_listList calendar entries (tasks and events), optionally filtered by kind, completion, lateness or date window.Read-only
List Tasks and Events
List calendar entries (tasks and events), optionally filtered by kind, completion, lateness or date window. Returns a page of entries (id, type, name, description, due_date or start/end time, complete, owner, category, association) plus pagination. Use it to find tasks and events. Use pipelinecrm_calendar_entry_get for one entry.
Inputs
completedboolean
Set to true to return only completed items. Example: true
include_inactiveboolean
Set to true to include inactive entries (deleted occurrences of recurring series). Example: true
incompleteboolean
Set to true to return only incomplete items. Example: true
kindstring
Only return tasks or only events. Use task or event. Example: taskone of taskevent
lateboolean
Set to true to return only late (overdue) items. Example: true
modified_fromstring
Only return records whose last-modified date is on or after this date (YYYY-MM-DD, user's time zone). Example: 2026-01-01
modified_tostring
Only return records whose last-modified date is on or before this date (YYYY-MM-DD, user's time zone). Example: 2026-03-31
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
within_fromstring
Only return items that occur after this date (YYYY-MM-DD). Example: 2026-09-01
within_tostring
Only return items that occur before this date (YYYY-MM-DD). Example: 2026-09-30
pipelinecrm_calendar_entry_getRetrieve one calendar entry (task or event) by ID.Read-only
Get Task or Event
Retrieve one calendar entry (task or event) by ID. Returns the entry: type, name, description, due date or start/end time, completion, owner, category, priority, status, association and recurrence. Use it when you have an entry ID. Use pipelinecrm_calendar_entries_list to find entries.
Inputs
calendar_entry_idintegerrequired
ID of the calendar entry. Example: 99231
pipelinecrm_calendar_entry_priorities_listList the task and event priorities configured in the Pipeline CRM account.Read-only
List Task Priorities
List the task and event priorities configured in the Pipeline CRM account. Returns id, name, position and color. Use it to find a calendar_entry_priority_id for tasks and events.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_calendar_entry_statuses_listList the task and event statuses (To-Do, Done and custom ones) configured in the Pipeline CRM account.Read-only
List Task Statuses
List the task and event statuses (To-Do, Done and custom ones) configured in the Pipeline CRM account. Returns id, name, position, color and status_type. Use it to find a calendar_entry_status_id for tasks and events.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_call_dispositions_listList the call dispositions (outcomes) configured in the Pipeline CRM account.Read-only
List Call Dispositions
List the call dispositions (outcomes) configured in the Pipeline CRM account. Returns id, name, color and position. Use it to interpret call outcomes on call logs.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_call_log_getRetrieve one phone call log by ID.Read-only
Get Call Log
Retrieve one phone call log by ID. Returns the call's direction, status, numbers, party, timing and linked note. Use it when you have a call log ID.
Inputs
call_log_idintegerrequired
ID of the call log. Example: 7310
pipelinecrm_call_logs_listList phone call logs you can see, written by the dialer and phone integration (read-only).Read-only
List Call Logs
List phone call logs you can see, written by the dialer and phone integration (read-only). Returns a page of calls (id, user, direction, status, from and to numbers, party, start time, duration, linked note) plus pagination. Use it to review call activity. Use pipelinecrm_call_log_get for one call.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_comments_listList every comment on notes you can see, newest first, optionally limited to a modified-date window.Read-only
List Comments
List every comment on notes you can see, newest first, optionally limited to a modified-date window. Returns a page of comments (id, comment text, user, created_at, updated_at) plus pagination. Use it to catch up on recent discussion. Use pipelinecrm_note_comments_list for one note's comments.
Inputs
modified_fromstring
Only return records whose last-modified date is on or after this date (YYYY-MM-DD, user's time zone). Example: 2026-01-01
modified_tostring
Only return records whose last-modified date is on or before this date (YYYY-MM-DD, user's time zone). Example: 2026-03-31
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_companies_autocompleteFind companies whose name starts with the given text.Read-only
Autocomplete Companies
Find companies whose name starts with the given text. Returns a short list of matches with id and name only (empty when the text is blank). Use it to resolve a company name to an ID quickly. Use pipelinecrm_companies_list for full records and filters.
Inputs
qstring
Text the company name should start with. Example: Acme
pipelinecrm_companies_listList companies, optionally filtered by name, email, owner, customer status, location or dates.Read-only
List Companies
List companies, optionally filtered by name, email, owner, customer status, location or dates. Returns a page of company records (id, name, email, web, phones, address, owner, tags) plus pagination. Use it to browse or filter companies. Use pipelinecrm_companies_autocomplete for a quick name lookup and pipelinecrm_company_get for one company.
Inputs
citystring
Only return companies whose city starts with this text. Example: Philadelphia
company_idsstring
Only return records matching these company IDs. One ID or a comma-separated list. Example: 3310,3311
created_fromstring
Only return records whose creation date is on or after this date (YYYY-MM-DD, user's time zone). Example: 2026-01-01
created_tostring
Only return records whose creation date is on or before this date (YYYY-MM-DD, user's time zone). Example: 2026-03-31
emailstring
Only return companies whose email starts with this text. Example: info@acme.com
is_customerstring
Only return companies that are (Yes) or are not (No) customers. Use Yes or No. Example: Noone of YesNo
modified_fromstring
Only return records whose last-modified date is on or after this date (YYYY-MM-DD, user's time zone). Example: 2026-01-01
modified_tostring
Only return records whose last-modified date is on or before this date (YYYY-MM-DD, user's time zone). Example: 2026-03-31
namestring
Only return companies whose name starts with this text. Example: Acme
name_exactstring
Only return companies whose name exactly matches this text. Example: Acme Corporation
owner_idsstring
Only return records matching these owner (user) IDs. One ID or a comma-separated list. Example: 13
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
search_idinteger
ID of a saved search (list view) to run. Any other filters you pass are merged over the saved search's own conditions. Get IDs from pipelinecrm_searches_list. Example: 5501
sortstring
Sort column key; prefix with - for descending and separate several keys with commas. Column keys include company_name. Example: -company_name
statestring
Only return companies whose state starts with this text. Example: PA
pipelinecrm_company_children_listList the child companies whose parent is the given company.Read-only
List Child Companies
List the child companies whose parent is the given company. Returns each child's id, name, parent_id, owner and deals value. Use it to explore a company hierarchy. Use pipelinecrm_company_parents_list for the other direction.
Inputs
company_idintegerrequired
ID of the parent company. Example: 3310
pipelinecrm_company_custom_fields_listList the custom fields defined for companies configured in the Pipeline CRM account.Read-only
List Company Custom Fields
List the custom fields defined for companies configured in the Pipeline CRM account. Returns id, name, field_type, record_type and is_required. Use it to learn the custom_label_<id> keys that company custom_fields expect.
Inputs
field_typestring
Only return custom fields of this type, such as dropdown, text, number or date. Example: dropdown
group_idinteger
Only return custom fields in the custom field group with this ID. Example: 3
namestring
Only return custom fields whose name contains this text. Example: Region
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_company_getRetrieve one company by ID.Read-only
Get Company
Retrieve one company by ID. Returns the full company record: name, description, email, web, phones, address, owner, tags, customer details and custom fields. Use it when you have a company ID. Use pipelinecrm_companies_list or pipelinecrm_companies_autocomplete to find one.
Inputs
company_idintegerrequired
ID of the company. Example: 3310
pipelinecrm_company_parents_listList the parent companies of the given company.Read-only
List Parent Companies
List the parent companies of the given company. Returns each parent's id, name, parent_id, owner and deals value. Use it to explore a company hierarchy. Use pipelinecrm_company_children_list for the other direction.
Inputs
company_idintegerrequired
ID of the child company. Example: 3311
pipelinecrm_company_people_listList the people who belong to one company.Read-only
List Company People
List the people who belong to one company. Returns a page of person records plus pagination. Use it to see a company's contacts. Use pipelinecrm_people_list to filter people across companies.
Inputs
company_idintegerrequired
ID of the company. Example: 3310
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_company_tags_listList the company tags configured in the Pipeline CRM account.Read-only
List Company Tags
List the company tags configured in the Pipeline CRM account. Returns id and name. Use it to find tag IDs for tag_ids on companies.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_contact_tags_listList the predefined tags for people (contacts) configured in the Pipeline CRM account.Read-only
List Contact Tags
List the predefined tags for people (contacts) configured in the Pipeline CRM account. Returns id, name and color. Use it to find tag IDs for predefined_contacts_tag_ids on people.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_currencies_listList every currency Pipeline CRM supports (not account-specific).Read-only
List Currencies
List every currency Pipeline CRM supports (not account-specific). Returns a page of currencies (id, name, code, symbol, decimal_places) plus pagination. Use it to map a currency ID on a deal to its code.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_custom_field_dropdown_entries_listList the dropdown options of custom fields configured in the Pipeline CRM account.Read-only
List Custom Field Dropdown Options
List the dropdown options of custom fields configured in the Pipeline CRM account. Returns id, custom_field_label_id, name and position. Use it to find the option ID to store in a dropdown custom field.
Inputs
custom_field_idinteger
Only return the options of the custom field label with this ID (from the custom field list tools). Example: 4821
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_deal_custom_fields_listList the custom fields defined for deals configured in the Pipeline CRM account.Read-only
List Deal Custom Fields
List the custom fields defined for deals configured in the Pipeline CRM account. Returns id, name, field_type, record_type and is_required. Use it to learn the custom_label_<id> keys that deal custom_fields expect.
Inputs
field_typestring
Only return custom fields of this type, such as dropdown, text, number or date. Example: dropdown
group_idinteger
Only return custom fields in the custom field group with this ID. Example: 3
namestring
Only return custom fields whose name contains this text. Example: Region
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_deal_getRetrieve one deal by its ID.Read-only
Get Deal
Retrieve one deal by its ID. Returns the full deal record: name, value, stage, status, probability, owner, company, primary contact, people, tags, custom fields and dates. Use it when you have a deal ID. Use pipelinecrm_deals_list to find deals by name or filters.
Inputs
deal_idintegerrequired
ID of the deal. Example: 4521
pipelinecrm_deal_loss_reasons_listList the deal loss reasons configured in the Pipeline CRM account.Read-only
List Deal Loss Reasons
List the deal loss reasons configured in the Pipeline CRM account. Returns id, name and position. Use it to find a deal_loss_reason_id when closing a deal as lost.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_deal_notes_listList the activities (notes) logged on one deal.Read-only
List Deal Notes
List the activities (notes) logged on one deal. Returns a page of notes (id, title, content, category, author, created_at) plus pagination. Use it to read a deal's activity history. Use pipelinecrm_notes_list to filter notes across deals, people and companies.
Inputs
deal_idintegerrequired
ID of the deal. Example: 4521
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_deal_pipelines_listList the deal pipelines configured in the Pipeline CRM account.Read-only
List Deal Pipelines
List the deal pipelines configured in the Pipeline CRM account. Returns id, name, default flag, pipeline_type, description, deal counts and won/lost stages. Use it to find a pipeline_id for the pipeline filter on pipelinecrm_deals_list.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_deal_stages_listList the deal stages configured in the account.Read-only
List Deal Stages
List the deal stages configured in the account. Returns each stage's id, name, percent and deal_pipeline_id, plus pagination. Use it to find a deal_stage_id for pipelinecrm_deal_create, pipelinecrm_deal_update or the stage filter on pipelinecrm_deals_list.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_deal_statuses_listList the deal statuses configured in the Pipeline CRM account.Read-only
List Deal Statuses
List the deal statuses configured in the Pipeline CRM account. Returns id, name, color, position and editable flag. Use it to find a status ID for pipelinecrm_deal_create or pipelinecrm_deal_update.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_deal_tags_listList the deal tags configured in the Pipeline CRM account.Read-only
List Deal Tags
List the deal tags configured in the Pipeline CRM account. Returns id and name. Use it to find tag IDs for tag_ids on deals.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_deal_totals_by_stage_getGet the count and total value of the deals you can see in every stage of the account's pipelines.Read-only
Get Deal Totals by Stage
Get the count and total value of the deals you can see in every stage of the account's pipelines. Returns one entry per stage: deal_stage_id, deal_stage_name, count and total. Use it for a pipeline summary. Use pipelinecrm_deals_list to see the individual deals.
Inputs
This tool takes no inputs.
pipelinecrm_deal_won_reasons_listList the deal won reasons configured in the Pipeline CRM account.Read-only
List Deal Won Reasons
List the deal won reasons configured in the Pipeline CRM account. Returns id, name and position. Use it to find a deal_won_reason_id when closing a deal as won.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_deals_listList deals in Pipeline CRM, optionally filtered by name, stage, pipeline, owner, status, value or dates.Read-only
List Deals
List deals in Pipeline CRM, optionally filtered by name, stage, pipeline, owner, status, value or dates. Returns a page of deal records (id, name, value, stage, status, owner, company, primary contact, expected close date) plus pagination (page, per_page, total). Use it to browse or filter deals. Use pipelinecrm_deal_get to fetch one deal by ID, and pipelinecrm_deal_totals_by_stage_get for pipeline totals.
Inputs
company_namestring
Only return deals whose company name contains this text. Example: Acme
created_fromstring
Only return records whose creation date is on or after this date (YYYY-MM-DD, user's time zone). Example: 2026-01-01
created_tostring
Only return records whose creation date is on or before this date (YYYY-MM-DD, user's time zone). Example: 2026-03-31
deal_idsstring
Only return records matching these deal IDs. One ID or a comma-separated list. Example: 4521,4522
expected_close_fromstring
Only return records whose expected close date is on or after this date (YYYY-MM-DD, user's time zone). Example: 2026-01-01
expected_close_tostring
Only return records whose expected close date is on or before this date (YYYY-MM-DD, user's time zone). Example: 2026-03-31
is_archivedstring
Only return archived (Yes) or non-archived (No) deals. Use Yes or No. Example: Noone of YesNo
modified_fromstring
Only return records whose last-modified date is on or after this date (YYYY-MM-DD, user's time zone). Example: 2026-01-01
modified_tostring
Only return records whose last-modified date is on or before this date (YYYY-MM-DD, user's time zone). Example: 2026-03-31
namestring
Only return deals whose name contains this text (case-insensitive). Example: Acme
owner_idsstring
Only return records matching these owner (user) IDs. One ID or a comma-separated list. Example: 13
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipeline_idinteger
Only return deals in the deal pipeline with this ID (from pipelinecrm_deal_pipelines_list). Example: 2
primary_contact_idinteger
Only return deals whose primary contact is the person with this ID. Example: 8802
search_idinteger
ID of a saved search (list view) to run. Any other filters you pass are merged over the saved search's own conditions. Get IDs from pipelinecrm_searches_list. Example: 5501
sortstring
Sort column key; prefix with - for descending and separate several keys with commas. Column keys include deal_name and deal_value. Example: -deal_value
source_idsstring
Only return records matching these lead source IDs. One ID or a comma-separated list. Example: 7
stage_idsstring
Only return records matching these deal stage IDs. One ID or a comma-separated list. Example: 3,4
status_idsstring
Only return records matching these deal status IDs. One ID or a comma-separated list. Example: 1
value_maxnumber
Only return deals worth at most this value. Example: 50000
value_minnumber
Only return deals worth at least this value. Example: 10000
pipelinecrm_document_getRetrieve one file (document) by ID.Read-only
Get File
Retrieve one file (document) by ID. Returns the file's title, size, owner, linked records, upload status and download URL. Use it to check a file or its upload status after pipelinecrm_document_create.
Inputs
document_idintegerrequired
ID of the file (document). Example: 6612
pipelinecrm_document_tags_listList the file (document) tags configured in the Pipeline CRM account.Read-only
List File Tags
List the file (document) tags configured in the Pipeline CRM account. Returns id and name. Use it to find tag IDs for files.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_documents_listList files (documents) attached to deals, people, companies or tasks, optionally filtered by record, name, type or owner.Read-only
List Files
List files (documents) attached to deals, people, companies or tasks, optionally filtered by record, name, type or owner. Returns a page of files (id, title, size, owner, linked deal/person/company, upload status, download URL) plus pagination. Use it to find files. Use pipelinecrm_document_get for one file.
Inputs
calendar_entry_idinteger
Filter documents by calendar entry ID (task or event). Example: 99231
company_idsstring
Only return records matching these company IDs. One ID or a comma-separated list. Example: 3310
deal_idsstring
Only return records matching these deal IDs. One ID or a comma-separated list. Example: 4521
document_typestring
Only return files of this kind: all, spreadsheets, images, documents, pds, presentations or others. Example: documentsone of allspreadsheetsimagesdocumentspdspresentationsothers
namestring
Only return files whose name contains this text. Example: proposal
owner_idsstring
Only return records matching these owner (user) IDs. One ID or a comma-separated list. Example: 13
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
person_idsstring
Only return records matching these person IDs. One ID or a comma-separated list. Example: 8802
sortstring
The attribute to sort on. Example: created_at
pipelinecrm_event_categories_listList the task and event categories configured in the Pipeline CRM account.Read-only
List Event Categories
List the task and event categories configured in the Pipeline CRM account. Returns id and name. Use it to find the category_id that pipelinecrm_calendar_entry_create requires.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_lead_sources_listList the lead sources configured in the Pipeline CRM account.Read-only
List Lead Sources
List the lead sources configured in the Pipeline CRM account. Returns id, name and cost per lead. Use it to find a source ID for deals (deal_source) or people (lead_source_id).
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_lead_statuses_listList the lead statuses configured in the Pipeline CRM account.Read-only
List Lead Statuses
List the lead statuses configured in the Pipeline CRM account. Returns id, name and color. Use it to find a lead_status_id for pipelinecrm_person_create or pipelinecrm_person_update.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_message_template_getRetrieve one email (message) template by ID.Read-only
Get Email Template
Retrieve one email (message) template by ID. Returns the template's name, subject, body, shared flag and attachments. Use it when you have a template ID.
Inputs
template_idintegerrequired
ID of the message template. Example: 220
pipelinecrm_message_templates_listList the email (message) templates you can use: your own plus shared ones.Read-only
List Email Templates
List the email (message) templates you can use: your own plus shared ones. Returns a page of templates (id, name, subject, body, shared flag, owner, attachments) plus pagination. Use it to find an email template. Use pipelinecrm_message_template_get for one template.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_note_categories_listList the note (activity) categories configured in the Pipeline CRM account.Read-only
List Note Categories
List the note (activity) categories configured in the Pipeline CRM account. Returns id and name. Use it to find a note_category_id for pipelinecrm_note_create.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_note_comment_getRetrieve one comment on an activity (note).Read-only
Get Note Comment
Retrieve one comment on an activity (note). Returns the comment's id, text, author and timestamps. Use it when you have both the note ID and the comment ID.
Inputs
comment_idintegerrequired
ID of the comment. Example: 5120
note_idintegerrequired
ID of the note (activity). Example: 70011
pipelinecrm_note_comments_listList the comments on one activity (note).Read-only
List Note Comments
List the comments on one activity (note). Returns a page of comments (id, comment text, user, created_at) plus pagination. Use it to read a note's discussion. Use pipelinecrm_comments_list for recent comments across all notes.
Inputs
note_idintegerrequired
ID of the note (activity). Example: 70011
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_note_getRetrieve one activity (note) by ID.Read-only
Get Note
Retrieve one activity (note) by ID. Returns the note: title, content, category, author, the deal/person/company it is on, notify list and comments. Use it when you have a note ID. Use pipelinecrm_notes_list to find notes.
Inputs
note_idintegerrequired
ID of the note (activity). Example: 70011
pipelinecrm_note_template_getRetrieve one note template by ID.Read-only
Get Note Template
Retrieve one note template by ID. Returns the template's content, note_category_id and notify_user_ids. Use it when you have a note template ID.
Inputs
template_idintegerrequired
ID of the note template. Example: 31
pipelinecrm_note_templates_listList the note templates in the account.Read-only
List Note Templates
List the note templates in the account. Returns a page of templates (id, content, note_category_id, notify_user_ids, owner) plus pagination. Use it to reuse standard note text with pipelinecrm_note_create.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_notes_listList activities (notes) attached to a deal, a person or a company, optionally filtered by text, category, author or date.Read-only
List Notes
List activities (notes) attached to a deal, a person or a company, optionally filtered by text, category, author or date. Returns a page of notes (id, title, content, category, author, deal/person/company IDs, created_at) plus pagination. Use it to search activity history. Pass at least one of deal_id, person_id or company_id; Pipeline CRM requires it. Use pipelinecrm_deal_notes_list or pipelinecrm_person_notes_list for one record's notes without filters.
Inputs
author_idsstring
Only return records matching these author (user) IDs. One ID or a comma-separated list. Example: 13
category_idsstring
Only return records matching these note category IDs. One ID or a comma-separated list. Example: 12
company_idinteger
Return notes on the company with this ID. At least one of deal_id, person_id or company_id is required. Example: 3310
created_fromstring
Only return records whose creation date is on or after this date (YYYY-MM-DD, user's time zone). Example: 2026-01-01
created_tostring
Only return records whose creation date is on or before this date (YYYY-MM-DD, user's time zone). Example: 2026-03-31
deal_idinteger
Return notes on the deal with this ID. At least one of deal_id, person_id or company_id is required. Example: 4521
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
person_idinteger
Return notes on the person with this ID. At least one of deal_id, person_id or company_id is required. Example: 8802
querystring
Free-text search across each note's title, content, category name and comments. Example: pricing
sortstring
Sort column key; prefix with - for descending and separate several keys with commas. Column keys include activity_created. Example: -activity_created
pipelinecrm_people_autocompleteFind people whose name starts with the given text, optionally limited to one company or one deal.Read-only
Autocomplete People
Find people whose name starts with the given text, optionally limited to one company or one deal. Returns a short list of matches with id and full_name only. Use it to resolve a name to a person ID quickly. Use pipelinecrm_people_list for full records and richer filters.
Inputs
company_idinteger
Only people at this company. Example: 3310
deal_idinteger
Only people on this deal. Example: 4521
qstring
Text the person's name should start with. Example: Acme
pipelinecrm_people_listList people (leads and contacts), optionally filtered by name, email, company, owner, type, lead status, source or dates.Read-only
List People
List people (leads and contacts), optionally filtered by name, email, company, owner, type, lead status, source or dates. Returns a page of person records (id, first and last name, email, phone, company, owner, type, lead status) plus pagination. Use it to browse or filter people. Use pipelinecrm_people_autocomplete for a quick name lookup and pipelinecrm_person_get for one person.
Inputs
company_idsstring
Only return records matching these company IDs. One ID or a comma-separated list. Example: 3310
company_namestring
Only return people whose company name contains this text. Example: Acme
created_fromstring
Only return records whose creation date is on or after this date (YYYY-MM-DD, user's time zone). Example: 2026-01-01
created_tostring
Only return records whose creation date is on or before this date (YYYY-MM-DD, user's time zone). Example: 2026-03-31
emailstring
Only return people whose work email contains this text. Example: jane@acme.com
lead_source_idsstring
Only return records matching these lead source IDs. One ID or a comma-separated list. Example: 7
lead_status_idsstring
Only return records matching these lead status IDs. One ID or a comma-separated list. Example: 2
modified_fromstring
Only return records whose last-modified date is on or after this date (YYYY-MM-DD, user's time zone). Example: 2026-01-01
modified_tostring
Only return records whose last-modified date is on or before this date (YYYY-MM-DD, user's time zone). Example: 2026-03-31
namestring
Only return people whose first or last name contains this text. Example: Jane
owner_idsstring
Only return records matching these owner (user) IDs. One ID or a comma-separated list. Example: 13
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
search_idinteger
ID of a saved search (list view) to run. Any other filters you pass are merged over the saved search's own conditions. Get IDs from pipelinecrm_searches_list. Example: 5501
simple_searchstring
Only return people whose first name, last name, email or company name contains this text. Example: acme
sortstring
Sort column key; prefix with - for descending and separate several keys with commas. Column keys include person_last_name. Example: person_last_name
typestring
Only return leads or contacts. Use Lead or Contact. Example: Contactone of LeadContact
pipelinecrm_performance_lanes_listList the performance lanes (product lines) configured in the Pipeline CRM account.Read-only
List Performance Lanes
List the performance lanes (product lines) configured in the Pipeline CRM account. Returns the account's performance lanes. Use it to interpret the deal_product_lines on deals.
Inputs
This tool takes no inputs.
pipelinecrm_person_custom_fields_listList the custom fields defined for people configured in the Pipeline CRM account.Read-only
List Person Custom Fields
List the custom fields defined for people configured in the Pipeline CRM account. Returns id, name, field_type, record_type and is_required. Use it to learn the custom_label_<id> keys that person custom_fields expect.
Inputs
field_typestring
Only return custom fields of this type, such as dropdown, text, number or date. Example: dropdown
group_idinteger
Only return custom fields in the custom field group with this ID. Example: 3
namestring
Only return custom fields whose name contains this text. Example: Region
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_person_deals_listList the deals a person is associated with.Read-only
List Person Deals
List the deals a person is associated with. Returns a page of deal records plus pagination. Use it to see one person's deals. Use pipelinecrm_deals_list to filter deals across the account.
Inputs
person_idintegerrequired
ID of the person. Example: 8802
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_person_getRetrieve one person (lead or contact) by ID.Read-only
Get Person
Retrieve one person (lead or contact) by ID. Returns the full person record: name, emails, phones, position, company, owner, type, lead status and source, addresses, tags, deals and custom fields. Use it when you have a person ID. Use pipelinecrm_people_list or pipelinecrm_people_autocomplete to find one.
Inputs
person_idintegerrequired
ID of the person. Example: 8802
pipelinecrm_person_notes_listList the activities (notes) logged on one person.Read-only
List Person Notes
List the activities (notes) logged on one person. Returns a page of notes (id, title, content, category, author, created_at) plus pagination. Use it to read a person's activity history. Use pipelinecrm_notes_list to filter notes more broadly.
Inputs
person_idintegerrequired
ID of the person. Example: 8802
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_profile_getGet the profile of the user the API token belongs to.Read-only
Get My Profile
Get the profile of the user the API token belongs to. Returns id, first_name, last_name, avatar and whether the user is an account admin. Use it to find your own user ID (for owner filters) or to check the connection works.
Inputs
This tool takes no inputs.
pipelinecrm_project_associations_listList the deals, companies and people linked to a project, optionally by type.Read-only
List Project Associations
List the deals, companies and people linked to a project, optionally by type. Returns a page of associations (id, associable_type, associable_id, created_at) plus pagination. Use it to see what a project covers. The association id is what pipelinecrm_project_association_remove needs.
Inputs
project_idintegerrequired
ID of the project. Example: 88
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
typestring
Filter associations by entity type. Example: dealone of dealcompanyperson
pipelinecrm_project_custom_fields_listList the custom fields defined for projects configured in the Pipeline CRM account.Read-only
List Project Custom Fields
List the custom fields defined for projects configured in the Pipeline CRM account. Returns id, name, field_type, record_type and is_required. Use it to learn the custom_label_<id> keys that project custom_fields expect.
Inputs
field_typestring
Only return custom fields of this type, such as dropdown, text, number or date. Example: dropdown
group_idinteger
Only return custom fields in the custom field group with this ID. Example: 3
namestring
Only return custom fields whose name contains this text. Example: Region
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_project_getRetrieve one project by ID.Read-only
Get Project
Retrieve one project by ID. Returns the project's name, description, status, dates, owner, collaborators, milestones, counts and linked deals, companies and people. Use it when you have a project ID. Use pipelinecrm_projects_list to find projects.
Inputs
project_idintegerrequired
ID of the project. Example: 88
pipelinecrm_project_milestone_getRetrieve one project milestone by ID.Read-only
Get Project Milestone
Retrieve one project milestone by ID. Returns the milestone's name, project, status, dates and its tasks and events. Use it when you have a milestone ID.
Inputs
milestone_idintegerrequired
ID of the project milestone. Example: 301
pipelinecrm_project_milestone_statuses_listList the project milestone statuses configured in the Pipeline CRM account.Read-only
List Project Milestone Statuses
List the project milestone statuses configured in the Pipeline CRM account. Returns id, name, color, position and status_type. Use it to find a project_milestone_status_id for milestones.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_project_milestones_listList project milestones, optionally filtered by project, status or name.Read-only
List Project Milestones
List project milestones, optionally filtered by project, status or name. Returns a page of milestones (id, name, project, status, start and end dates, tasks, events) plus pagination. Use it to track project phases. Use pipelinecrm_project_milestone_get for one milestone.
Inputs
namestring
Only return milestones whose name contains this text. Example: Kickoff
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
project_idinteger
Only return milestones of the project with this ID. Example: 88
sortstring
Sort column key; prefix with - for descending and separate several keys with commas. Column keys include project_milestone_created_at. Example: project_milestone_created_at
status_idinteger
Only return milestones in the project milestone status with this ID (from pipelinecrm_project_milestone_statuses_list). Example: 2
pipelinecrm_project_templates_listList the project templates (account and system-wide) configured in the Pipeline CRM account.Read-only
List Project Templates
List the project templates (account and system-wide) configured in the Pipeline CRM account. Returns id, name, description, duration, milestones and collaborators. Use it to find a project_template_id for pipelinecrm_project_create.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_projects_autocompleteFind projects whose name matches the given text.Read-only
Autocomplete Projects
Find projects whose name matches the given text. Returns the matching projects (empty when the text is blank). Use it to resolve a project name to an ID. Use pipelinecrm_projects_list for filters and paging.
Inputs
qstring
The search query to match against project names. Example: Acme
pipelinecrm_projects_listList projects, optionally filtered by name, owner, status, archived state or start date.Read-only
List Projects
List projects, optionally filtered by name, owner, status, archived state or start date. Returns a page of projects (id, name, status, owner, dates, counts, linked deals and companies) plus pagination. Use it to browse projects. Use pipelinecrm_projects_autocomplete for a quick name lookup and pipelinecrm_project_get for one project.
Inputs
is_archivedstring
Only return archived (Yes) or non-archived (No) projects. Use Yes or No. Example: Noone of YesNo
namestring
Only return projects whose name contains this text. Example: Onboarding
owner_idinteger
Only return projects owned by the user with this ID. Example: 13
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
project_idsstring
Only return these projects. One ID or a comma-separated list. Example: 88,89
start_fromstring
Only return records whose start date is on or after this date (YYYY-MM-DD, user's time zone). Example: 2026-01-01
start_tostring
Only return records whose start date is on or before this date (YYYY-MM-DD, user's time zone). Example: 2026-03-31
statusstring
Only return open or closed projects. Example: openone of openclosed
pipelinecrm_revenue_types_listList the revenue types configured in the Pipeline CRM account.Read-only
List Revenue Types
List the revenue types configured in the Pipeline CRM account. Returns id, name, position and default flag. Use it to interpret a deal's revenue type.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_search_getRetrieve one saved search (list view) definition by ID.Read-only
Get Saved Search
Retrieve one saved search (list view) definition by ID. Returns its name, search_type, query conditions, columns and sort. Use it to inspect a list view. Use pipelinecrm_search_results_get to run it.
Inputs
search_idintegerrequired
ID of the saved search. Example: 5501
pipelinecrm_search_results_getRun a saved search (list view) and return its matching records.Read-only
Run Saved Search
Run a saved search (list view) and return its matching records. Returns a page of results (deals, people, companies or activities, depending on the search type) plus pagination. Use it to reuse a list view built in the app. Find search IDs with pipelinecrm_searches_list or pipelinecrm_starred_searches_list.
Inputs
search_idintegerrequired
ID of the saved search to run. Example: 5501
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_searches_listList the saved searches (list views) you can use.Read-only
List Saved Searches
List the saved searches (list views) you can use. Returns a page of searches (id, name, search_type, query, columns, starred and shared flags) plus pagination. Use it to find a search ID for pipelinecrm_search_results_get or the search_id filter on the list tools.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_starred_search_getRetrieve one starred search by ID.Read-only
Get Starred Search
Retrieve one starred search by ID. Returns its id, name, search_type, result_count, url and updated_at. Use it when you have a starred search ID.
Inputs
search_idintegerrequired
ID of the starred search. Example: 5501
pipelinecrm_starred_searches_listList the list views you have starred, optionally of one type (5 per page by default).Read-only
List Starred Searches
List the list views you have starred, optionally of one type (5 per page by default). Returns starred searches (id, name, and with include_search_details: search_type, result_count, url, updated_at). Use it to find your go-to list views. Use pipelinecrm_searches_list for every saved search.
Inputs
include_search_detailsboolean
Add `search_type`, `result_count`, `url` and `updated_at` to each entry. Example: true
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
search_typestring
Only starred searches of this type. Example: dealsone of dealspeoplecompaniesactivities
pipelinecrm_sub_entries_listList the sub-tasks or sub-events under a task or event, oldest first.Read-only
List Sub-tasks
List the sub-tasks or sub-events under a task or event, oldest first. Returns the sub-entries with id, type, name, due date or times and completion. Use it to see a task's checklist. Use pipelinecrm_calendar_entry_get for the parent entry.
Inputs
calendar_entry_idintegerrequired
ID of the parent calendar entry. Example: 99231
pipelinecrm_teams_listList the teams configured in the Pipeline CRM account.Read-only
List Teams
List the teams configured in the Pipeline CRM account. Returns id, name, parent_id and permissions. Use it to find team IDs for project collaborators or owner-team filters.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_todo_templates_listList the todo templates configured in the Pipeline CRM account.Read-only
List Todo Templates
List the todo templates configured in the Pipeline CRM account. Returns id, name, template_type, default flag and template items. Use it to find a todo_template_id to apply when creating a deal, person or company.
Inputs
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
pipelinecrm_user_getRetrieve one user by ID.Read-only
Get User
Retrieve one user by ID. Returns the user's name, email, phones, role and account details. Use it when you have a user ID. Use pipelinecrm_users_list to find users.
Inputs
user_idintegerrequired
ID of the user. Example: 13
pipelinecrm_users_listList the users in the account that you can see, optionally filtered by email, phone or admin role.Read-only
List Users
List the users in the account that you can see, optionally filtered by email, phone or admin role. Returns a page of users (id, full_name, email, phone, admin flag, last seen) plus pagination. Use it to find a user ID for owner or assignee fields. Use pipelinecrm_user_get for one user.
Inputs
adminboolean
Return only account administrators. Example: true
emailstring
Find a user with the exact email. Example: jane@acme.com
including_inactiveboolean
Return all users, including inactive ones (default returns only active). Example: true
pageinteger
Page number to return, starting at 1. Default 1. Example: 1
per_pageinteger
Number of records per page, at most 200. Default 200. Example: 50
phonestring
Find users whose work or mobile phone matches (formatting ignored). Example: 215-555-0100
pipelinecrm_calendar_entry_createCreate a task or an event, optionally linked to a deal, person or company.Write
Create Task or Event
Create a task or an event, optionally linked to a deal, person or company. Returns the new calendar entry with its id. Use it to schedule a follow-up task (type CalendarTask with due_date) or a meeting (type CalendarEvent with start_time and end_time). category_id is required; get one from pipelinecrm_event_categories_list.
Inputs
category_idintegerrequired
The event category. You can retrieve a list of event categories using the event categories api. Example: 2
activeboolean
Set false to mark the entry inactive (functionally deleted). Example: true
all_dayboolean
Whether the entry lasts all day. Example: false
association_idinteger
The `id` of the associated person, company, or deal. Example: 4521
association_typestring
The type of association. Example: Dealone of DealCompanyPerson
calendar_entry_priority_idinteger
The event priority. You can retrieve a list of event priorities using the event priorities api. Example: 2
calendar_entry_status_idinteger
The event status. You can retrieve a list of event statuses using the event statuses admin api. Example: 2
company_idinteger
If this event is tied directly with a company, then this will be set to the company id. Example: 3310
completeboolean
Whether the task is complete. Set true to mark it done. Example: false
deliver_assignment_emailboolean
If `true`, and you are assigning the calendar entry to a different user, the system will send an assignment email to the new user. Setting it to `false` will disable sending an assignment email. Example: true
descriptionstring
Longer description of the task or event. Example: The meeting is at 3:30
due_datestring
Due date for a task, as YYYY-MM-DD. Example: 2026-09-08
end_timestring
End time for an event, in the user's time zone (YYYY-MM-DD HH:MM:SS). Example: 2026-09-08 15:30:00
exdatestring
Specify an exdate to change the recurrence rule. This string follows the iCalendar spec, RFC2445. Example: 20261117T140000
exrulestring
Specify an exrule to change the recurrence rule. This string follows the iCalendar spec, RFC2445. Example: FREQ=MONTHLY;BYMONTHDAY=1
namestring
Name (title) of the task or event. Example: Follow up on proposal
rdatestring
Specify an rdate to change the recurrence rule. This string follows the iCalendar spec, RFC2445. Example: 20261103T140000
rrulestring
Specify an rrule to change the recurrence rule. This string follows the iCalendar spec, RFC2445. Example: FREQ=WEEKLY;BYDAY=TU
start_timestring
Start time for an event, in the user's time zone (YYYY-MM-DD HH:MM:SS). Example: 2026-09-08 15:00:00
typestring
CalendarTask for a task (uses due_date) or CalendarEvent for an event (uses start_time and end_time). Example: CalendarTaskone of CalendarEventCalendarTask
pipelinecrm_calendar_entry_updateUpdate an existing task or event; only the fields you pass change.Write
Update Task or Event
Update an existing task or event; only the fields you pass change. Returns the updated calendar entry. Use it to reschedule, rename or mark a task complete (complete true). Use pipelinecrm_calendar_entry_create for a new entry.
- Idempotent
Inputs
calendar_entry_idintegerrequired
ID of the calendar entry to update. Example: 99231
activeboolean
Set false to mark the entry inactive (functionally deleted). Example: true
all_dayboolean
Whether the entry lasts all day. Example: false
association_idinteger
The `id` of the associated person, company, or deal. Example: 4521
association_typestring
The type of association. Example: Dealone of DealCompanyPerson
calendar_entry_priority_idinteger
The event priority. You can retrieve a list of event priorities using the event priorities api. Example: 2
calendar_entry_status_idinteger
The event status. You can retrieve a list of event statuses using the event statuses admin api. Example: 2
category_idinteger
The event category. You can retrieve a list of event categories using the event categories api. Example: 2
company_idinteger
If this event is tied directly with a company, then this will be set to the company id. Example: 3310
completeboolean
Whether the task is complete. Set true to mark it done. Example: false
deliver_reassignment_emailboolean
If `true`, and you are assigning the calendar entry to a different user, the system will send an assignment email to the new user. Setting it to `false` will disable sending an assignment email. Example: true
descriptionstring
Longer description of the task or event. Example: The meeting is at 3:30
due_datestring
Due date for a task, as YYYY-MM-DD. Example: 2026-09-08
end_timestring
End time for an event, in the user's time zone (YYYY-MM-DD HH:MM:SS). Example: 2026-09-08 15:30:00
exdatestring
Specify an exdate to change the recurrence rule. This string follows the iCalendar spec, RFC2445. Example: 20261117T140000
exrulestring
Specify an exrule to change the recurrence rule. This string follows the iCalendar spec, RFC2445. Example: FREQ=MONTHLY;BYMONTHDAY=1
namestring
Name (title) of the task or event. Example: Follow up on proposal
rdatestring
Specify an rdate to change the recurrence rule. This string follows the iCalendar spec, RFC2445. Example: 20261103T140000
rrulestring
Specify an rrule to change the recurrence rule. This string follows the iCalendar spec, RFC2445. Example: FREQ=WEEKLY;BYDAY=TU
start_timestring
Start time for an event, in the user's time zone (YYYY-MM-DD HH:MM:SS). Example: 2026-09-08 15:00:00
typestring
CalendarTask for a task (uses due_date) or CalendarEvent for an event (uses start_time and end_time). Example: CalendarTaskone of CalendarEventCalendarTask
pipelinecrm_company_child_addLink a company as a child of another company.Write
Add Child Company
Link a company as a child of another company. Returns the updated parent company. Use it to build a company hierarchy. Requires the company hierarchy feature; a cycle or self-link is rejected.
Inputs
child_company_idintegerrequired
ID of the company to link as a child. Example: 3311
company_idintegerrequired
ID of the parent company. Example: 3310
pipelinecrm_company_createCreate a company in Pipeline CRM.Write
Create Company
Create a company in Pipeline CRM. Returns the new company record with its id. Use it to add an organization you sell to. Set check_for_duplicates to true to reject a company whose name already exists. Use pipelinecrm_company_update to change one.
Inputs
namestringrequired
The name of the company. Example: Acme Corporation
address_1string
First line of business address. Example: 500 Market St
address_2string
Second line of business address. Example: 123 Fake St.
check_for_duplicatesboolean
If `true`, the system will return an error if you attempt to create a duplicate company. A duplicate is any company that that has the same name as any other company in your account. Example: `https://api.pipelinecrm.com/api/companies.json?api_key=XXXXXXXXXXXXXXXXXXXXXXXXX&app_key=XXXXXXXXXXXXXXXXXXXXXXXXX&check_for_duplicates=true`
citystring
Business address city. Example: San Francisco
countrystring
Business address country. Example: USA
custom_fieldsobject
Custom field values keyed custom_label_<id>, where <id> is the custom field label ID from pipelinecrm_company_custom_fields_list. Example: {"custom_label_4821": "Enterprise"}
deliver_assignment_emailboolean
If `true`, and you are assigning the company to a different user, the system will send an assignment email to the new user. Setting it to `false` will disable sending an assignment email. Example: true
descriptionstring
Free-text description of the company. Example: Regional distributor of industrial parts.
emailstring
The email of the company. Example: hello@acme.example
facebook_urlstring
URL to company's facebook profile. Example: https://www.facebook.com/abc.company
faxstring
The company's fax number. Example: +1 415 555 0199
instant_messagestring
Company's IM username. Example: abc-company
linked_in_urlstring
URL to company's LinkedIn profile. Example: https://www.linkedin.com/in/abc-company
owner_idinteger
The ID of the owner of the company. Example: 13
phone1string
Primary business number. Example: +1 415 555 0100
phone1_descstring
Description for the primary business number. Example: Head Office call line
phone2string
Secondary business number. Example: 123-123-1234
phone2_descstring
Description for the secondary business number. Example: Billing department number
phone3string
Extra business number. Example: 123-123-1234
phone3_descstring
Description for an extra business number. Example: Backup line for billing
phone4string
Extra business number. Example: 123-123-1234
phone4_descstring
Description for an extra business number. Example: Backup line for billing
postal_codestring
Business address postal code. Example: 94105
shared_user_idsarray
The array of User IDs with whom this company's been shared (also known as Collaborators). Example: [1, 2, 3]
statestring
Business address state. Example: CA
tag_idsarray
IDs of the tags to set on this company. Example: [3, 4, 5]
todo_template_idinteger
ID of a todo template to apply, creating its tasks on this record (from pipelinecrm_todo_templates_list). Example: 1
todo_template_user_idinteger
User ID to own the tasks created from the todo template. Example: 13473
twitterstring
Company's twitter username. Example: abc-company
webstring
The company's website. Example: https://acme.example
pipelinecrm_company_parent_addLink a company as a parent of another company.Write
Add Parent Company
Link a company as a parent of another company. Returns the updated child company. Use it to build a company hierarchy. Requires the company hierarchy feature; a cycle or self-link is rejected.
Inputs
company_idintegerrequired
ID of the child company. Example: 3311
parent_company_idintegerrequired
ID of the company to link as the parent. Example: 3310
pipelinecrm_company_updateUpdate fields on an existing company; only the fields you pass change.Write
Update Company
Update fields on an existing company; only the fields you pass change. Returns the updated company record. Use it to edit company details or reassign the owner. Use pipelinecrm_company_create for a new company.
- Idempotent
Inputs
company_idintegerrequired
ID of the company to update. Example: 3310
address_1string
First line of business address. Example: 500 Market St
address_2string
Second line of business address. Example: 123 Fake St.
citystring
Business address city. Example: San Francisco
countrystring
Business address country. Example: USA
custom_fieldsobject
Custom field values keyed custom_label_<id>, where <id> is the custom field label ID from pipelinecrm_company_custom_fields_list. Example: {"custom_label_4821": "Enterprise"}
deliver_reassignment_emailboolean
If `true`, and you are changing a company's `owner_id`, the system will send an assignment email to the new user. Example turning it off: `https://api.pipelinecrm.com/api/v3/companies/123.json?api_key=XXXXXXXXXXXXXXXXXXXXXXXXX&app_key=XXXXXXXXXXXXXXXXXXXXXXXXX&deliver_reassignment_email=false`
descriptionstring
Free-text description of the company. Example: Regional distributor of industrial parts.
emailstring
The email of the company. Example: hello@acme.example
facebook_urlstring
URL to company's facebook profile. Example: https://www.facebook.com/abc.company
faxstring
The company's fax number. Example: +1 415 555 0199
instant_messagestring
Company's IM username. Example: abc-company
linked_in_urlstring
URL to company's LinkedIn profile. Example: https://www.linkedin.com/in/abc-company
namestring
The name of the company. Example: Acme Corporation
owner_idinteger
The ID of the owner of the company. Example: 13
phone1string
Primary business number. Example: +1 415 555 0100
phone1_descstring
Description for the primary business number. Example: Head Office call line
phone2string
Secondary business number. Example: 123-123-1234
phone2_descstring
Description for the secondary business number. Example: Billing department number
phone3string
Extra business number. Example: 123-123-1234
phone3_descstring
Description for an extra business number. Example: Backup line for billing
phone4string
Extra business number. Example: 123-123-1234
phone4_descstring
Description for an extra business number. Example: Backup line for billing
postal_codestring
Business address postal code. Example: 94105
shared_user_idsarray
The array of User IDs with whom this company's been shared (also known as Collaborators). Example: [1, 2, 3]
statestring
Business address state. Example: CA
tag_idsarray
IDs of the tags to set on this company. Example: [3, 4, 5]
todo_template_idinteger
ID of a todo template to apply, creating its tasks on this record (from pipelinecrm_todo_templates_list). Example: 1
todo_template_user_idinteger
User ID to own the tasks created from the todo template. Example: 13473
twitterstring
Company's twitter username. Example: abc-company
webstring
The company's website. Example: https://acme.example
pipelinecrm_customer_createConvert a company into a customer record, with an optional health score.Write
Create Customer
Convert a company into a customer record, with an optional health score. Returns the new customer record with its id. Use it when a company becomes a paying customer. Use pipelinecrm_customer_update to change the health score later.
Inputs
company_idintegerrequired
ID of the company to convert to a customer. Example: 1
health_scorestring
The health of the relationship with this customer. Example: middleone of lowmiddlehigh
health_score_descriptionstring
Explanation or notes for the health score. Example: Very positive engagement recently - relationship is improving!
pipelinecrm_customer_updateUpdate a customer's health score or its description.Write
Update Customer
Update a customer's health score or its description. Returns the updated customer record. Use it to record how the customer relationship is going.
- Idempotent
Inputs
customer_idintegerrequired
ID of the customer. Example: 410
health_scorestring
The health of the relationship with this customer. Example: middleone of lowmiddlehigh
health_score_descriptionstring
Explanation or notes for the health score. Example: Very positive engagement recently - relationship is improving!
pipelinecrm_deal_createCreate a deal in Pipeline CRM.Write
Create Deal
Create a deal in Pipeline CRM. Returns the new deal record with its id. Use it to add a sale you are working on. Use pipelinecrm_deal_update to change an existing deal. Look up stage, status and source IDs first with pipelinecrm_deal_stages_list, pipelinecrm_deal_statuses_list and pipelinecrm_lead_sources_list.
Inputs
namestringrequired
The name of the deal. Example: Acme Corporation - Q4 renewal
address_1string
The first line of the deal's address. Example: 123 Main St.
address_2string
The second line of the deal's address. Example: Suite 100
citystring
The city of the deal's address. Example: San Francisco
closed_timestring
The date the deal actually closed (either won or lost). YYYY-MM-DD format. Example: 2026-10-15
company_idinteger
The ID of the company associated to this deal. Example: 3310
company_namestring
Creates a new Company associated to this deal if provided. Example: Acme Corporation
countrystring
The country of the deal's address. Example: USA
custom_fieldsobject
Custom field values keyed custom_label_<id>, where <id> is the custom field label ID from pipelinecrm_deal_custom_fields_list. Example: {"custom_label_4821": "Enterprise"}
deal_loss_reason_idinteger
The ID of the Deal Loss Reason for this deal. Example: 123
deal_loss_reason_notesstring
Explanatory or descriptive text about why the deal was lost. Example: Too expensive
deal_sourceinteger
ID of this deal's lead source (from pipelinecrm_lead_sources_list). Example: 5
deal_stage_idinteger
ID of the deal stage this deal is in (from pipelinecrm_deal_stages_list). Example: 3
deal_won_reason_idinteger
The ID of the Deal Won Reason for this deal. Example: 4
deal_won_reason_notesstring
Explanatory or descriptive text about why the deal was won. Example: Great value for the price
deliver_assignment_emailboolean
If `true`, and you are assigning the deal to a different user, the system will send an assignment email to the new user. Setting it to `false` will disable sending an assignment email. Example: true
expected_close_datestring
The date the deal is expected to close by (YYYY-MM-DD format). Example: 2026-10-15
is_archivedboolean
Flag for archived status. Example: false
person_idsarray
IDs of Person records associated to this deal. Example: [1, 2, 3]
postal_codestring
The postal code of the deal's address. Example: 94105
primary_contact_idinteger
The ID of the primary contact Person record associated with this deal. Example: 8802
probabilityinteger
The probability, from 0-100, that the deal will close. Note that if you set the probability to 0 or 100, the deal will close. Similarly, if the deal is closed, and you set the probability to 1-99, the deal will re-open and closed_time will be set to nil. Example: 60
shared_user_idsarray
The array of User IDs with whom this deal's been shared (also known as Collaborators). Example: [1, 2, 3]
statestring
The state of the deal's address. Example: CA
statusinteger
ID of the deal status for this deal (from pipelinecrm_deal_statuses_list). Example: 1
summarystring
Explanatory or descriptive text about the deal. Example: Renewal of the 120-seat plan; legal review in progress.
tag_idsarray
IDs of the tags to set on this deal. Example: [3, 4, 5]
todo_template_idinteger
ID of a todo template to apply, creating its tasks on this record (from pipelinecrm_todo_templates_list). Example: 1
todo_template_user_idinteger
User ID to own the tasks created from the todo template. Example: 13473
user_idinteger
The ID of the user who owns this deal. Example: 13
valuenumber
The deal's value in its currency, as a number. Example: 12000
pipelinecrm_deal_updateUpdate fields on an existing deal; only the fields you pass change.Write
Update Deal
Update fields on an existing deal; only the fields you pass change. Returns the updated deal record. Use it to move a deal to another stage, change its value or owner, or close it. Use pipelinecrm_deal_create for a new deal.
- Idempotent
Inputs
deal_idintegerrequired
ID of the deal to update. Example: 4521
address_1string
The first line of the deal's address. Example: 123 Main St.
address_2string
The second line of the deal's address. Example: Suite 100
citystring
The city of the deal's address. Example: San Francisco
closed_timestring
The date the deal actually closed (either won or lost). YYYY-MM-DD format. Example: 2026-10-15
company_idinteger
The ID of the company associated to this deal. Example: 3310
company_namestring
Creates a new Company associated to this deal if provided. Example: Acme Corporation
countrystring
The country of the deal's address. Example: USA
custom_fieldsobject
Custom field values keyed custom_label_<id>, where <id> is the custom field label ID from pipelinecrm_deal_custom_fields_list. Example: {"custom_label_4821": "Enterprise"}
deal_loss_reason_idinteger
The ID of the Deal Loss Reason for this deal. Example: 123
deal_loss_reason_notesstring
Explanatory or descriptive text about why the deal was lost. Example: Too expensive
deal_sourceinteger
ID of this deal's lead source (from pipelinecrm_lead_sources_list). Example: 5
deal_stage_idinteger
ID of the deal stage this deal is in (from pipelinecrm_deal_stages_list). Example: 3
deal_won_reason_idinteger
The ID of the Deal Won Reason for this deal. Example: 4
deal_won_reason_notesstring
Explanatory or descriptive text about why the deal was won. Example: Great value for the price
deliver_reassignment_emailboolean
If `true`, and you are assigning the deal to a different user, the system will send an assignment email to the new user. Setting it to `false` will disable sending an assignment email. Example: true
expected_close_datestring
The date the deal is expected to close by (YYYY-MM-DD format). Example: 2026-10-15
is_archivedboolean
Flag for archived status. Example: false
namestring
The name of the deal. Example: Acme Corporation - Q4 renewal
person_idsarray
IDs of Person records associated to this deal. Example: [1, 2, 3]
postal_codestring
The postal code of the deal's address. Example: 94105
primary_contact_idinteger
The ID of the primary contact Person record associated with this deal. Example: 8802
probabilityinteger
The probability, from 0-100, that the deal will close. Note that if you set the probability to 0 or 100, the deal will close. Similarly, if the deal is closed, and you set the probability to 1-99, the deal will re-open and closed_time will be set to nil. Example: 60
shared_user_idsarray
The array of User IDs with whom this deal's been shared (also known as Collaborators). Example: [1, 2, 3]
statestring
The state of the deal's address. Example: CA
statusinteger
ID of the deal status for this deal (from pipelinecrm_deal_statuses_list). Example: 1
summarystring
Explanatory or descriptive text about the deal. Example: Renewal of the 120-seat plan; legal review in progress.
tag_idsarray
IDs of the tags to set on this deal. Example: [3, 4, 5]
todo_template_idinteger
ID of a todo template to apply, creating its tasks on this record (from pipelinecrm_todo_templates_list). Example: 1
todo_template_user_idinteger
User ID to own the tasks created from the todo template. Example: 13473
user_idinteger
The ID of the user who owns this deal. Example: 13
valuenumber
The deal's value in its currency, as a number. Example: 12000
pipelinecrm_document_createAdd a file to Pipeline CRM from a publicly reachable URL; Pipeline downloads it in the background.Write
Create File from URL
Add a file to Pipeline CRM from a publicly reachable URL; Pipeline downloads it in the background. Returns the new file record; its upload_status shows when the download finishes. Use it to attach a file to a deal, person, company or task. Poll pipelinecrm_document_get to confirm the upload completed.
Inputs
urlstringrequired
The url the document is available at. Example: https://app.pipelinecrm.com/documents/7710
calendar_entry_idinteger
The id of the calendar entry (task or event). Example: 123
company_idinteger
The id of the company. Example: 123
deal_idinteger
The id of the deal. Example: 123
owner_idinteger
The id of the document owner. Example: 123
person_idinteger
The id of the person. Example: 123
primary_association_idinteger
The id of the primary association (Deal, Person, Company, or CalendarEntry). Alternative way to associate documents with entities. Example: 123
primary_association_typestring
The type of the primary association. When associating with a calendar entry, use CalendarTask or CalendarEvent. Example: CalendarTaskone of DealPersonCompanyCalendarTaskCalendarEvent
titlestring
The filename the document. Example: Acme-renewal-quote-v2.pdf
pipelinecrm_document_updateUpdate a file's title, linked records or source URL; only the fields you pass change.Write
Update File
Update a file's title, linked records or source URL; only the fields you pass change. Returns the updated file record. Use it to rename or relink a file, or to retry a failed upload with a new url.
- Idempotent
Inputs
document_idintegerrequired
ID of the file (document) to update. Example: 6612
calendar_entry_idinteger
The id of the calendar entry (task or event). Example: 123
company_idinteger
The id of the company. Example: 123
deal_idinteger
The id of the deal. Example: 123
owner_idinteger
The id of the document owner. Example: 123
person_idinteger
The id of the person. Example: 123
primary_association_idinteger
The id of the primary association (Deal, Person, Company, or CalendarEntry). Alternative way to associate documents with entities. Example: 123
primary_association_typestring
The type of the primary association. When associating with a calendar entry, use CalendarTask or CalendarEvent. Example: CalendarTaskone of DealPersonCompanyCalendarTaskCalendarEvent
titlestring
The filename the document. Example: Acme-renewal-quote-v2.pdf
urlstring
The url the document is available at. Example: https://app.pipelinecrm.com/documents/7710
pipelinecrm_note_comment_createAdd a comment to an existing activity (note).Write
Create Note Comment
Add a comment to an existing activity (note). Returns the new comment with its id. Use it to reply on a note. Use pipelinecrm_note_create to log a new activity instead.
Inputs
commentstringrequired
The text of the comment. Example: Sent the revised quote.
note_idintegerrequired
ID of the note (activity) to comment on. Example: 70011
user_idinteger
User ID of the comment's owner. Defaults to the authenticated user. Example: 13
pipelinecrm_note_comment_updateEdit a comment on an activity (note).Write
Update Note Comment
Edit a comment on an activity (note). Returns the updated comment. Use it to correct a comment's text. Only the comment's author or an account admin can update it.
- Idempotent
Inputs
comment_idintegerrequired
ID of the comment to update. Example: 5120
note_idintegerrequired
ID of the note (activity). Example: 70011
commentstring
The text of the comment. Example: Sent the revised quote.
edited_by_person_idinteger
User ID of the person editing the comment. Set it when updating a comment. Example: 1
user_idinteger
User ID of the comment's owner. Defaults to the authenticated user. Example: 13
pipelinecrm_note_createLog an activity (note) on a deal, person or company.Write
Create Note
Log an activity (note) on a deal, person or company. Returns the new note with its id. Use it to record a call summary, meeting note or update. Set deal_id, person_id or company_id to attach it. Use pipelinecrm_note_comment_create to reply to an existing note.
Inputs
contentstringrequired
The note content. Example: This is the content
company_idinteger
The company id of the note. Example: 3310
deal_idinteger
The deal id of the note. Example: 4521
milestone_idinteger
ID of the project milestone this note belongs to, if any. Example: 88
note_category_idinteger
The category of the note. Example: 2
notify_user_idsarray
IDs of users who get an email when new comments are added to this note. Example: [1, 2, 3, 4, 5]
person_idinteger
The person id of the note. Example: 8802
titlestring
The note title, if any. Example: Call with Jane about the renewal
user_idinteger
The owner of the note. Example: 13
pipelinecrm_note_updateUpdate an existing activity (note); only the fields you pass change.Write
Update Note
Update an existing activity (note); only the fields you pass change. Returns the updated note. Use it to correct a note's title, content, category or attachment. Use pipelinecrm_note_create for a new note.
- Idempotent
Inputs
note_idintegerrequired
ID of the note (activity) to update. Example: 70011
company_idinteger
The company id of the note. Example: 3310
contentstring
The note content. Example: This is the content
deal_idinteger
The deal id of the note. Example: 4521
milestone_idinteger
ID of the project milestone this note belongs to, if any. Example: 88
note_category_idinteger
The category of the note. Example: 2
notify_user_idsarray
IDs of users who get an email when new comments are added to this note. Example: [1, 2, 3, 4, 5]
person_idinteger
The person id of the note. Example: 8802
titlestring
The note title, if any. Example: Call with Jane about the renewal
user_idinteger
The owner of the note. Example: 13
pipelinecrm_person_createCreate a person (lead or contact) in Pipeline CRM.Write
Create Person
Create a person (lead or contact) in Pipeline CRM. Returns the new person record with its id. Use it to add a lead or contact; give at least a name or an email. Use pipelinecrm_person_update to change an existing person.
Inputs
bouncedboolean
Whether or not the person has had emails sent to them bounce. Example: false
company_idinteger
The ID of the company associated to this person. Example: 3310
company_namestring
Associates the company with this name to this person, creating it if none matches. Example: Acme Corporation
created_by_user_idinteger
The user recorded as the creator. Defaults to the authenticated user. Example: 13
custom_fieldsobject
Custom field values keyed custom_label_<id>, where <id> is the custom field label ID from pipelinecrm_person_custom_fields_list. Example: {"custom_label_4821": "Enterprise"}
deal_idsarray
The deals the person is associated with. Set to the full list; deals left out are disassociated. Example: [4521]
deliver_assignment_emailstring
Create. Sits beside `person`, not inside it (also accepted as a query parameter). Pass `"false"` to skip the email normally sent when the record is assigned to another user. Example: falseone of truefalse
do_not_validate_emailstring
Sits beside `person`, not inside it. Pass `"true"` to save a person whose `email` would otherwise be rejected as malformed. Example: falseone of truefalse
emailstring
Person's primary email address. Example: jane.rivera@acme.example
email2string
Person's secondary email address. Example: james.smith@acme-inc.com
facebook_urlstring
URL to person's facebook profile. Example: https://www.facebook.com/james.smith
faxstring
The person's fax number. Example: +1 215-555-0199
first_namestring
The person's first name. Example: Jane
full_namestring
The person's full name. Will split on whitespace to set `first_name` and `last_name` fields. Example: Jane Rivera
home_address_1string
First line of Home address. Example: Suite 101.
home_address_2string
Second line of Home address. Example: 123 Fake St.
home_citystring
Home address city. Example: Denver
home_countrystring
Home address country. Example: United States
home_emailstring
Person's non-professional email address. Example: james.smith@gmail.com
home_phonestring
Person's home phone number. Example: 123-123-1234
home_postal_codestring
Home address postal code. Example: 11001
home_statestring
Home address state. Example: Colorado
instant_messagestring
Person's IM username. Example: james_smith_20
is_key_contactboolean
Whether or not this person is a key contact for the company. Example: true
last_namestring
The person's last name. Example: Rivera
lead_source_idinteger
The ID of the lead source to set for this person. Example: 5
lead_status_idinteger
The ID of the lead status to set for this person. Example: 2
linked_in_urlstring
URL to person's LinkedIn profile. Example: https://www.linkedin.com/in/james-smith-101
mobilestring
Person's mobile phone number. Example: +1 415 555 0177
phonestring
Person's primary phone number. Example: +1 415 555 0142
positionstring
Person's professional position. Example: Head of Operations
predefined_contacts_tag_idsarray
IDs of the tags to set on this person. Example: [3, 4, 5]
relationshipstring
The relationship of the person to the company (e.g. "Father", "CEO", "Owner", etc.)
shared_user_idsarray
The array of User IDs with whom this person's been shared (also known as Collaborators). Example: [1, 2, 3]
summarystring
Summary or notes on the person. Example: Owns the renewal decision; prefers email.
todo_template_idinteger
ID of a todo template to apply, creating its tasks on this record (from pipelinecrm_todo_templates_list). Example: 1
todo_template_user_idinteger
User ID to own the tasks created from the todo template. Example: 13473
twitterstring
Person's twitter username. Example: james.smith
typestring
Whether the record is a Contact or a Lead. Setting it on update converts the record. Example: Contactone of ContactLead
unsubscribedboolean
Whether or not the person has unsubscribed to newsletters. Example: false
user_idinteger
The ID of the user who owns this person record. Example: 13
websitestring
Person's website URL. Example: http://www.james-smith.com
work_address_1string
First line of work address. Example: Suite 101
work_address_2string
Second line of work address. Example: 123 Fake St.
work_citystring
Work address city. Example: Denver
work_countrystring
Work address country. Example: United States
work_postal_codestring
Work address postal code. Example: 11001
work_statestring
Work address state. Example: Colorado
pipelinecrm_person_updateUpdate fields on an existing person; only the fields you pass change.Write
Update Person
Update fields on an existing person; only the fields you pass change. Returns the updated person record. Use it to edit contact details, reassign the owner, change lead status or convert a lead to a contact (type). Use pipelinecrm_person_create for a new person.
- Idempotent
Inputs
person_idintegerrequired
ID of the person to update. Example: 8802
bouncedboolean
Whether or not the person has had emails sent to them bounce. Example: false
company_idinteger
The ID of the company associated to this person. Example: 3310
company_namestring
Associates the company with this name to this person, creating it if none matches. Example: Acme Corporation
custom_fieldsobject
Custom field values keyed custom_label_<id>, where <id> is the custom field label ID from pipelinecrm_person_custom_fields_list. Example: {"custom_label_4821": "Enterprise"}
deal_idsarray
The deals the person is associated with. Set to the full list; deals left out are disassociated. Example: [4521]
deliver_reassignment_emailstring
Update. Sits beside `person`, not inside it. Pass `"false"` to skip the email normally sent when `user_id` changes to another user. Example: falseone of truefalse
do_not_validate_emailstring
Sits beside `person`, not inside it. Pass `"true"` to save a person whose `email` would otherwise be rejected as malformed. Example: falseone of truefalse
emailstring
Person's primary email address. Example: jane.rivera@acme.example
email2string
Person's secondary email address. Example: james.smith@acme-inc.com
facebook_urlstring
URL to person's facebook profile. Example: https://www.facebook.com/james.smith
faxstring
The person's fax number. Example: +1 215-555-0199
first_namestring
The person's first name. Example: Jane
full_namestring
The person's full name. Will split on whitespace to set `first_name` and `last_name` fields. Example: Jane Rivera
home_address_1string
First line of Home address. Example: Suite 101.
home_address_2string
Second line of Home address. Example: 123 Fake St.
home_citystring
Home address city. Example: Denver
home_countrystring
Home address country. Example: United States
home_emailstring
Person's non-professional email address. Example: james.smith@gmail.com
home_phonestring
Person's home phone number. Example: 123-123-1234
home_postal_codestring
Home address postal code. Example: 11001
home_statestring
Home address state. Example: Colorado
instant_messagestring
Person's IM username. Example: james_smith_20
is_key_contactboolean
Whether or not this person is a key contact for the company. Example: true
last_namestring
The person's last name. Example: Rivera
lead_source_idinteger
The ID of the lead source to set for this person. Example: 5
lead_status_idinteger
The ID of the lead status to set for this person. Example: 2
linked_in_urlstring
URL to person's LinkedIn profile. Example: https://www.linkedin.com/in/james-smith-101
mobilestring
Person's mobile phone number. Example: +1 415 555 0177
phonestring
Person's primary phone number. Example: +1 415 555 0142
positionstring
Person's professional position. Example: Head of Operations
predefined_contacts_tag_idsarray
IDs of the tags to set on this person. Example: [3, 4, 5]
relationshipstring
The relationship of the person to the company (e.g. "Father", "CEO", "Owner", etc.)
shared_user_idsarray
The array of User IDs with whom this person's been shared (also known as Collaborators). Example: [1, 2, 3]
summarystring
Summary or notes on the person. Example: Owns the renewal decision; prefers email.
todo_template_idinteger
ID of a todo template to apply, creating its tasks on this record (from pipelinecrm_todo_templates_list). Example: 1
todo_template_user_idinteger
User ID to own the tasks created from the todo template. Example: 13473
twitterstring
Person's twitter username. Example: james.smith
typestring
Whether the record is a Contact or a Lead. Setting it on update converts the record. Example: Contactone of ContactLead
unsubscribedboolean
Whether or not the person has unsubscribed to newsletters. Example: false
user_idinteger
The ID of the user who owns this person record. Example: 13
websitestring
Person's website URL. Example: http://www.james-smith.com
work_address_1string
First line of work address. Example: Suite 101
work_address_2string
Second line of work address. Example: 123 Fake St.
work_citystring
Work address city. Example: Denver
work_countrystring
Work address country. Example: United States
work_postal_codestring
Work address postal code. Example: 11001
work_statestring
Work address state. Example: Colorado
pipelinecrm_project_archiveArchive a project so it drops out of default project lists.Write
Archive Project
Archive a project so it drops out of default project lists. Returns the archived project. Use it to put away finished work without deleting it. Use pipelinecrm_project_unarchive to restore it.
- Idempotent
Inputs
project_idintegerrequired
ID of the project to archive. Example: 88
pipelinecrm_project_association_addLink a deal, company or person to a project.Write
Add Project Association
Link a deal, company or person to a project. Adding an existing link returns it without error. Returns the association record. Use it to attach records to a project after it was created.
Inputs
associable_idintegerrequired
The ID of the entity to associate. Example: 123
associable_typestringrequired
The type of entity to associate. Example: Dealone of DealCompanyPerson
project_idintegerrequired
ID of the project. Example: 88
pipelinecrm_project_createCreate a project, optionally from a template or a deal, with linked records, collaborators and milestones.Write
Create Project
Create a project, optionally from a template or a deal, with linked records, collaborators and milestones. Returns the new project with its id. Use it to start delivery work after a deal closes. Use pipelinecrm_project_update to change one.
Inputs
namestringrequired
The name of the project. Must be unique within the account (among non-archived projects). Example: Acme onboarding
company_idsarray
IDs of Companies to associate with this project. Example: [10, 20]
custom_fieldsobject
Custom field values keyed custom_label_<id>, where <id> is the custom field label ID from pipelinecrm_project_custom_fields_list. Example: {"custom_label_4821": "Enterprise"}
deal_idsarray
IDs of Deals to associate with this project. Example: [1, 2, 3]
descriptionstring
Explanatory or descriptive text about the project. Example: Complete redesign of the company website with new branding
end_datestring
The end date of the project (YYYY-MM-DD format). Must be after start_date. Example: 2026-12-15
hex_colorstring
The color associated with the project (hex code). Example: #4A90D9
owner_idinteger
The ID of the user who owns this project. Cannot be an external user. Example: 13473
person_idsarray
IDs of People to associate with this project. Example: [100, 200]
project_milestones_attributesarray
Milestones to create or change inline with the project. Each item has a name and optional project_milestone_status_id, start_date and end_date; include an existing milestone's id to update it, or id plus _destroy true to remove it. Example: []
project_template_idinteger
Create-only. The ID of the project template to seed this project from. Provided as a property of the `project` object on create. Ignored on update. Example: 6
source_deal_idinteger
Create-only. The ID of the deal to source initial project data from. Provided as a property of the `project` object on create. Ignored on update. Example: 42
start_datestring
The start date of the project (YYYY-MM-DD format). Example: 2026-09-15
statusstring
The status of the project: - `open`: Active project - `closed`: Completed project. Example: openone of openclosed
team_idsarray
IDs of Teams to add as collaborators on this project. Example: [1]
user_idsarray
IDs of Users to add as collaborators on this project. Example: [5, 6]
pipelinecrm_project_milestone_createAdd a milestone to a project, optionally with tasks and events.Write
Create Project Milestone
Add a milestone to a project, optionally with tasks and events. Returns the new milestone with its id. Use it to plan a project phase. Use pipelinecrm_project_milestone_update to change it.
Inputs
namestringrequired
The name of the milestone. Must be unique within the project. Example: Kickoff
project_idintegerrequired
ID of the project. Example: 88
end_datestring
The end date of the milestone (YYYY-MM-DD format). Must be after start_date. Example: 2025-02-28
milestone_events_attributesarray
Events to create or change inline with the milestone. Each item has a name, start and end date and time (start_time_date, start_time_time as HH:MM, end_time_date, end_time_time), all_day and owner_id; include an existing event's id to update it, or id plus _destroy true to remove it. Example: []
milestone_tasks_attributesarray
Tasks to create or change inline with the milestone. Each item has a name and optional due_date and owner_id; include an existing task's id to update it, or id plus _destroy true to remove it. Example: []
project_milestone_status_idinteger
The ID of the project milestone status. Defaults to the "Not Started" status if not provided. Example: 1
start_datestring
The start date of the milestone (YYYY-MM-DD format). Example: 2025-01-15
pipelinecrm_project_milestone_updateUpdate a project milestone; only the fields you pass change.Write
Update Project Milestone
Update a project milestone; only the fields you pass change. Returns the updated milestone. Use it to rename, reschedule or change the status of a milestone, or edit its tasks and events.
- Idempotent
Inputs
milestone_idintegerrequired
ID of the project milestone to update. Example: 301
end_datestring
The end date of the milestone (YYYY-MM-DD format). Must be after start_date. Example: 2025-02-28
milestone_events_attributesarray
Events to create or change inline with the milestone. Each item has a name, start and end date and time (start_time_date, start_time_time as HH:MM, end_time_date, end_time_time), all_day and owner_id; include an existing event's id to update it, or id plus _destroy true to remove it. Example: []
milestone_tasks_attributesarray
Tasks to create or change inline with the milestone. Each item has a name and optional due_date and owner_id; include an existing task's id to update it, or id plus _destroy true to remove it. Example: []
namestring
The name of the milestone. Must be unique within the project. Example: Kickoff
project_milestone_status_idinteger
The ID of the project milestone status. Defaults to the "Not Started" status if not provided. Example: 1
start_datestring
The start date of the milestone (YYYY-MM-DD format). Example: 2025-01-15
pipelinecrm_project_unarchiveRestore an archived project.Write
Unarchive Project
Restore an archived project. Returns the restored project. Use it to bring back a project archived with pipelinecrm_project_archive.
- Idempotent
Inputs
project_idintegerrequired
ID of the project to unarchive. Example: 88
pipelinecrm_project_updateUpdate an existing project; only the fields you pass change.Write
Update Project
Update an existing project; only the fields you pass change. Returns the updated project. Use it to change a project's status, dates, owner, links or milestones. Use pipelinecrm_project_archive to archive it.
- Idempotent
Inputs
project_idintegerrequired
ID of the project to update. Example: 88
company_idsarray
IDs of Companies to associate with this project. Example: [10, 20]
custom_fieldsobject
Custom field values keyed custom_label_<id>, where <id> is the custom field label ID from pipelinecrm_project_custom_fields_list. Example: {"custom_label_4821": "Enterprise"}
deal_idsarray
IDs of Deals to associate with this project. Example: [1, 2, 3]
descriptionstring
Explanatory or descriptive text about the project. Example: Complete redesign of the company website with new branding
end_datestring
The end date of the project (YYYY-MM-DD format). Must be after start_date. Example: 2026-12-15
hex_colorstring
The color associated with the project (hex code). Example: #4A90D9
namestring
The name of the project. Must be unique within the account (among non-archived projects). Example: Acme onboarding
owner_idinteger
The ID of the user who owns this project. Cannot be an external user. Example: 13473
person_idsarray
IDs of People to associate with this project. Example: [100, 200]
project_milestones_attributesarray
Milestones to create or change inline with the project. Each item has a name and optional project_milestone_status_id, start_date and end_date; include an existing milestone's id to update it, or id plus _destroy true to remove it. Example: []
start_datestring
The start date of the project (YYYY-MM-DD format). Example: 2026-09-15
statusstring
The status of the project: - `open`: Active project - `closed`: Completed project. Example: openone of openclosed
team_idsarray
IDs of Teams to add as collaborators on this project. Example: [1]
user_idsarray
IDs of Users to add as collaborators on this project. Example: [5, 6]
pipelinecrm_sub_entry_createAdd a sub-task or sub-event under an existing task or event; it inherits the parent's owner, category and links.Write
Create Sub-task
Add a sub-task or sub-event under an existing task or event; it inherits the parent's owner, category and links. Returns the new sub-entry with its id. Use it to break a task into steps. Requires the sub-tasks feature on the account.
Inputs
calendar_entry_idintegerrequired
ID of the parent calendar entry. Example: 99231
namestringrequired
Name (title) of the task or event. Example: Follow up on proposal
activeboolean
Set false to mark the entry inactive (functionally deleted). Example: true
all_dayboolean
Whether the entry lasts all day. Example: false
descriptionstring
Longer description of the task or event. Example: Walk through pricing options and agree next steps.
due_datestring
Due date for a task, as YYYY-MM-DD. Example: 2026-09-10
end_timestring
End time for an event, in the user's time zone (YYYY-MM-DD HH:MM:SS). Example: 2026-10-20 15:00:00
start_timestring
Start time for an event, in the user's time zone (YYYY-MM-DD HH:MM:SS). Example: 2026-10-20 14:00:00
subentry_statusstring
Free-form status label shown on the sub-entry. Example: Waiting on legal
typestring
CalendarTask for a task (uses due_date) or CalendarEvent for an event (uses start_time and end_time). Example: CalendarTaskone of CalendarEventCalendarTask
pipelinecrm_sub_entry_updateUpdate a sub-task or sub-event; only the fields you pass change (its type cannot change).Write
Update Sub-task
Update a sub-task or sub-event; only the fields you pass change (its type cannot change). Returns the updated sub-entry. Use it to rename, reschedule or mark a sub-task done.
- Idempotent
Inputs
calendar_entry_idintegerrequired
ID of the parent calendar entry. Example: 99231
sub_entry_idintegerrequired
ID of the sub-entry to update. Example: 99240
activeboolean
Set false to mark the entry inactive (functionally deleted). Example: true
all_dayboolean
Whether the entry lasts all day. Example: false
descriptionstring
Longer description of the task or event. Example: Walk through pricing options and agree next steps.
due_datestring
Due date for a task, as YYYY-MM-DD. Example: 2026-09-10
end_timestring
End time for an event, in the user's time zone (YYYY-MM-DD HH:MM:SS). Example: 2026-10-20 15:00:00
namestring
Name (title) of the task or event. Example: Follow up on proposal
start_timestring
Start time for an event, in the user's time zone (YYYY-MM-DD HH:MM:SS). Example: 2026-10-20 14:00:00
subentry_statusstring
Free-form status label shown on the sub-entry. Example: Waiting on legal
pipelinecrm_calendar_entry_deleteDelete a task or event by ID.Destructive
Delete Task or Event
Delete a task or event by ID. Returns an empty success response. Use it to remove an entry. To close a task instead, set complete with pipelinecrm_calendar_entry_update.
- Idempotent
Inputs
calendar_entry_idintegerrequired
ID of the calendar entry to delete. Example: 99231
pipelinecrm_company_child_removeUnlink a child company from its parent; neither company is deleted.Destructive
Remove Child Company
Unlink a child company from its parent; neither company is deleted. Returns the updated parent company. Use it to change a company hierarchy.
- Idempotent
Inputs
child_company_idintegerrequired
ID of the linked child company. Example: 3311
company_idintegerrequired
ID of the parent company. Example: 3310
pipelinecrm_company_deletePermanently delete a company by ID.Destructive
Delete Company
Permanently delete a company by ID. Returns an empty success response. Use it only to remove a company for good.
- Idempotent
Inputs
company_idintegerrequired
ID of the company to delete. Example: 3310
pipelinecrm_company_parent_removeUnlink a parent company from a company; neither company is deleted.Destructive
Remove Parent Company
Unlink a parent company from a company; neither company is deleted. Returns the updated child company. Use it to change a company hierarchy.
- Idempotent
Inputs
company_idintegerrequired
ID of the child company. Example: 3311
parent_company_idintegerrequired
ID of the linked parent company. Example: 3310
pipelinecrm_customer_deleteDelete a customer record by its customer ID.Destructive
Delete Customer
Delete a customer record by its customer ID. Returns an empty success response. Use it to stop treating a company as a customer.
- Idempotent
Inputs
customer_idintegerrequired
ID of the customer to delete. Example: 410
pipelinecrm_deal_deletePermanently delete a deal by its ID.Destructive
Delete Deal
Permanently delete a deal by its ID. Returns an empty success response. Use it only to remove a deal for good. To keep history, archive it with pipelinecrm_deal_update (is_archived) instead.
- Idempotent
Inputs
deal_idintegerrequired
ID of the deal to delete. Example: 4521
pipelinecrm_document_deletePermanently delete a file (document) by ID.Destructive
Delete File
Permanently delete a file (document) by ID. Returns an empty success response. Use it only to remove a file for good.
- Idempotent
Inputs
document_idintegerrequired
ID of the file (document) to delete. Example: 6612
pipelinecrm_note_comment_deleteDelete a comment from an activity (note).Destructive
Delete Note Comment
Delete a comment from an activity (note). Returns an empty success response. Use it to remove a comment for good.
- Idempotent
Inputs
comment_idintegerrequired
ID of the comment to delete. Example: 5120
note_idintegerrequired
ID of the note (activity). Example: 70011
pipelinecrm_note_deletePermanently delete an activity (note) by ID.Destructive
Delete Note
Permanently delete an activity (note) by ID. Returns an empty success response. Use it only to remove a note for good.
- Idempotent
Inputs
note_idintegerrequired
ID of the note (activity) to delete. Example: 70011
pipelinecrm_person_deletePermanently delete a person (lead or contact) by ID.Destructive
Delete Person
Permanently delete a person (lead or contact) by ID. Returns an empty success response. Use it only to remove a person for good.
- Idempotent
Inputs
person_idintegerrequired
ID of the person to delete. Example: 8802
pipelinecrm_project_association_removeRemove one deal, company or person link from a project; the record itself is not deleted.Destructive
Remove Project Association
Remove one deal, company or person link from a project; the record itself is not deleted. Returns an empty success response. Use it with an association id from pipelinecrm_project_associations_list.
- Idempotent
Inputs
association_idintegerrequired
ID of the project association. Example: 1203
project_idintegerrequired
ID of the project. Example: 88
pipelinecrm_project_deletePermanently delete a project by ID.Destructive
Delete Project
Permanently delete a project by ID. Returns an empty success response. Use it only to remove a project for good; use pipelinecrm_project_archive to hide it instead.
- Idempotent
Inputs
project_idintegerrequired
ID of the project to delete. Example: 88
pipelinecrm_project_milestone_deleteDelete a project milestone by ID.Destructive
Delete Project Milestone
Delete a project milestone by ID. Returns an empty success response. Use it to remove a milestone from a project.
- Idempotent
Inputs
milestone_idintegerrequired
ID of the project milestone to delete. Example: 301
pipelinecrm_sub_entry_deleteDelete a sub-task or sub-event.Destructive
Delete Sub-task
Delete a sub-task or sub-event. Returns an empty success response. Use it to remove a step from a task.
- Idempotent
Inputs
calendar_entry_idintegerrequired
ID of the parent calendar entry. Example: 99231
sub_entry_idintegerrequired
ID of the sub-entry to delete. Example: 99240

Setup

Install the SDK

Set your credentials

Create the Pipeline CRM connection

Authorize a user and make your first call

Tools

Call it

Returns

List Audits

Inputs

List Tasks and Events

Inputs

Get Task or Event

Inputs

List Task Priorities

Inputs

List Task Statuses

Inputs

List Call Dispositions

Inputs

Get Call Log

Inputs

List Call Logs

Inputs

List Comments

Inputs

Autocomplete Companies

Inputs

List Companies

Inputs

List Child Companies

Inputs

List Company Custom Fields

Inputs

Get Company

Inputs

List Parent Companies

Inputs

List Company People

Inputs

List Company Tags

Inputs

List Contact Tags

Inputs

List Currencies

Inputs

List Custom Field Dropdown Options

Inputs

List Deal Custom Fields

Inputs

Get Deal

Inputs

List Deal Loss Reasons

Inputs

List Deal Notes

Inputs

List Deal Pipelines

Inputs

List Deal Stages

Inputs

List Deal Statuses

Inputs

List Deal Tags

Inputs

Get Deal Totals by Stage

Inputs

List Deal Won Reasons

Inputs

List Deals

Inputs

Get File

Inputs

List File Tags

Inputs

List Files

Inputs

List Event Categories

Inputs

List Lead Sources

Inputs