Pipeline CRM integration: operations for AI agents
Pipeline CRM connects to Type.com as an integration. This page lists the 291 operations documented for Claude and Codex in Type.com: 128 read, 55 write, 108 destructive.
About Pipeline CRM
Pipeline CRM is a sales-focused customer relationship management tool designed to help teams track leads, manage deals, and streamline workflows.
Categories: Sales & CRM
How to connect Pipeline CRM to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
291 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
291 operations listed.
Account notifications
- Read
List account notifications
GET /account_notifications
- Read
Retrieve account notification
GET /account_notifications/{id}
- Write
Create account notification
POST /account_notifications
- Destructive
Update account notification
PUT /account_notifications/{id}
- Destructive
Delete account notification
DELETE /account_notifications/{id}
Activities (Notes)
- Read
List activities
Notes are attached to companies, deals, or people. In order to get a list of notes you must query the assocation by id.
- Read
Retrieve activity
GET /notes/{id}
- Read
Export notes as CSV
The same list as the JSON endpoint, as a CSV file with the columns the account's list view shows. Accepts the same conditions and sort parameters; not paginated. Requires the user's export permission.
- Write
Create activity
POST /notes
- Destructive
Update activity
PUT /notes/{id}
- Destructive
Delete activity
DELETE /notes/{id}
Call logs
- Read
List call logs
Call logs visible to the authenticated user. Soft-deleted calls are omitted. Read-only: call logs are written by Pipeline Phone and other phone integrations, not through this API.
- Read
Get a call log
GET /call_logs/{id}
Calendar Entries (Tasks & Events)
- Read
List calendar entries
Filtered request example — One user's open tasks and events in September 2026: curl -g -H "Authorization: Bearer pcrmliveXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \ "https://api.pipelinecrm.com/api/v3/calendarentries.json?conditions[when][fromdate]=2026-09-01&conditions[when][tod…
- Read
Retrieve calendar entry
To retrieve files attached to a calendar entry, use the /documents endpoint with the calendarentryid query parameter. See the Files (Documents) section for more details.
- Read
List a calendar entry's sub-entries
Sub-tasks of a task, oldest first.
- Read
Export calendar entries as CSV
The same list as the JSON endpoint, as a CSV file with the columns the account's list view shows. Accepts the same conditions and sort parameters; not paginated. Requires the user's export permission.
- Write
Create calendar entry
POST /calendar_entries
- Write
Create a sub-entry
Adds a sub-task or sub-event under this entry. Requires the sub-tasks feature on the account (403 otherwise). The sub-entry inherits the parent's associations; only the fields below can be set.
- Destructive
Update calendar entry
PUT /calendar_entries/{id}
- Destructive
Delete calendar entry
DELETE /calendar_entries/{id}
- Destructive
Update a sub-entry
type cannot be changed after creation.
- Destructive
Delete a sub-entry
DELETE /calendar_entries/{calendar_entry_id}/sub_calendar_entries/{id}
Comments
- Read
List comments
Comments are attached to notes (called "activities" in the Pipeline UI). In order to get a list of comments, you must query the note by id.
- Read
Retrieve comment
GET /notes/{note_id}/comments/{id}
- Read
List comments
Every comment on notes visible to you, newest first. To list one note's comments use /notes/{noteid}/comments.
- Read
Retrieve comment
GET /comments/{id}
- Write
Create comment
POST /notes/{note_id}/comments
- Write
Create comment
Same as POST /notes/{noteid}/comments, with the note given as noteid in the body. Users named in notifyuserids are added to the note's notification recipients.
- Destructive
Update comment
PUT /notes/{note_id}/comments/{id}
- Destructive
Delete comment
DELETE /notes/{note_id}/comments/{id}
- Destructive
Update comment
Notification recipients cannot be changed after creation; notifyuserids is ignored here. Only the comment's author or an account administrator may update it; anyone else receives 401.
- Destructive
Delete comment
DELETE /comments/{id}
Companies
- Read
List companies
Filtered request example — Companies named Acme…, owned by user 13, created in the last 30 days: curl -g -H "Authorization: Bearer pcrmliveXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \ "https://api.pipelinecrm.com/api/v3/companies.json?conditions[companyname]=Acme&conditions[compan…
- Read
Autocomplete companies
Lightweight name search for pickers. Returns an empty array when q is blank.
- Read
Retrieve company
Retrieve a single company or retrieve associations for a company (notes, people, deals, calendarentries): GET /api/v3/companies/1234/notes.json GET /api/v3/companies/1234/people.json GET /api/v3/companies/1234/deals.json GET /api/v3/companies/1234/calendarentries.json
- Read
List a company's people
GET /companies/{id}/people
- Read
List a company's child companies
Companies whose parent is this company.
- Read
List a company's parent companies
The parent chain of this company.
- Read
Export companies as CSV
The same list as the JSON endpoint, as a CSV file with the columns the account's list view shows. Accepts the same conditions and sort parameters; not paginated. Requires the user's export permission.
- Write
Create company
POST /companies
- Write
Add a child company
Links id as a child of this company and returns the updated company. Requires the company hierarchy feature; a link that would create a cycle, or a company linked to itself, is rejected with 422.
- Write
Add a parent company
Links id as a parent of this company and returns the updated company. Requires the company hierarchy feature; a link that would create a cycle, or a company linked to itself, is rejected with 422.
- Destructive
Update company
PUT /companies/{id}
- Destructive
Delete company
Only account administrators may delete companies; other users receive 403.
- Destructive
Remove a child company
Unlinks the child and returns the updated company. The child company itself is not deleted.
- Destructive
Remove a parent company
Unlinks the parent and returns the updated company. The parent company itself is not deleted.
Customers
- Write
Create customer
POST /customers
- Destructive
Update customer
PUT /customers/{id}
- Destructive
Delete customer
DELETE /customers/{id}
Deals
- Read
List deals
Filtered request example — Open deals in two stages, owned by one user, created last quarter, worth 10,000 or more, biggest first: curl -g -H "Authorization: Bearer pcrmliveXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \ "https://api.pipelinecrm.com/api/v3/deals.json?conditions[deals…
- Read
Deal totals by stage
Count and total value of the deals visible to you in every stage of the account's pipelines.
- Read
Retrieve deal
GET /deals/{id}
- Read
List a deal's notes
GET /deals/{id}/notes
- Read
Export deals as CSV
The same list as the JSON endpoint, as a CSV file with the columns the account's list view shows. Accepts the same conditions and sort parameters; not paginated. Requires the user's export permission.
- Write
Create deal
POST /deals
- Destructive
Update deal
PUT /deals/{id}
- Destructive
Delete deal
DELETE /deals/{id}
Files (Documents)
- Read
List files
Filtered request example — Documents on one deal whose name contains proposal: curl -g -H "Authorization: Bearer pcrmliveXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \ "https://api.pipelinecrm.com/api/v3/documents.json?conditions[documentdealid]=4521&conditions[documentname]=proposa…
- Read
Retrieve file
GET /documents/{id}
- Write
Create files
To create a document using the api, you must pass a url as an attribute of the document. The url must be a publicly accessible url where the endpoint exists. We will then grab the document from that url and upload it to Pipeline in the background. The steps are as follows: 1.
- Destructive
Update file
You can update a document's url if there was a problem when creating a document. If you update a document's url, we will attempt to get the document from that url again, and update the uploadstatus as described in the create documentation above.
- Destructive
Delete file
DELETE /documents/{id}
People
- Read
List people
Filtered request example — People at companies named Acme with lead status 2, changed in the last week: curl -g -H "Authorization: Bearer pcrmliveXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \ "https://api.pipelinecrm.com/api/v3/people.json?conditions[personcompanyname]=Acme&conditi…
- Read
Autocomplete people
Lightweight name search for pickers. Optionally limited to one company's or one deal's people.
- Read
Retrieve person
GET /people/{id}
- Read
List a person's deals
GET /people/{id}/deals
- Read
List a person's notes
GET /people/{id}/notes
- Read
Export people as CSV
The same list as the JSON endpoint, as a CSV file with the columns the account's list view shows. Accepts the same conditions and sort parameters; not paginated. Requires the user's export permission.
- Write
Create person
POST /people
- Destructive
Update person
PUT /people/{id}
- Destructive
Delete person
DELETE /people/{id}
Profile
- Read
Retrieve profile
GET /profile
Searches
- Read
List searches
GET /searches
- Read
Retrieve search
GET /searches/{id}
- Read
Retrieve search results
GET /searches/{id}/perform
- Read
Retrieve search results
POST /searches/{id}/perform
- Read
Retrieve search results
POST /searches/perform
- Write
Create search
POST /searches
- Destructive
Update search
PUT /searches/{id}
Projects
- Read
List projects
Filtered request example — Open projects owned by one user that started this quarter: curl -g -H "Authorization: Bearer pcrmliveXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \ "https://api.pipelinecrm.com/api/v3/projects.json?conditions[projectstatus]=open&conditions[projectowner]=13…
- Read
Autocomplete projects
Search for projects by name. Returns a list of projects matching the query string. If the query string is blank, returns an empty array.
- Read
Retrieve project
GET /projects/{id}
- Write
Create project
POST /projects
- Write
Unarchive project (PATCH alias)
Equivalent to PUT /projects/{id}/unarchive.
- Write
Invite collaborator to project
Sends an invitation email to a user to collaborate on the project.
- Destructive
Update project
PUT /projects/{id}
- Destructive
Delete project
DELETE /projects/{id}
- Destructive
Archive project
Archives the project. Archived projects are excluded from default list queries. Also accepts PATCH.
- Destructive
Archive project (PATCH alias)
Equivalent to PUT /projects/{id}/archive.
- Destructive
Unarchive project
Restores an archived project back to active status. Also accepts PATCH.
Project milestones
- Read
List milestones for a project
GET /projects/{project_id}/project_milestones
- Read
List project milestones
Filtered request example — Milestones of one project in one status, oldest first: curl -g -H "Authorization: Bearer pcrmliveXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \ "https://api.pipelinecrm.com/api/v3/projectmilestones.json?conditions[projectmilestoneproject]=88&conditions[pro…
- Read
Autocomplete project milestones
Search for milestones by name. Returns a list of milestones matching the query string. If the query string is blank, returns an empty array.
- Read
Retrieve project milestone
GET /project_milestones/{id}
- Write
Create milestone under a project
POST /projects/{project_id}/project_milestones
- Write
Create project milestone
Create a project milestone. projectid must be provided to identify the project the milestone belongs to — either as a top-level body field (shown here) or as a property of the nested projectmilestone object.
- Write
Bulk action on project milestones
Perform a bulk action on multiple project milestones at once. The action may run in the background for large selections.
- Destructive
Update project milestone
PUT /project_milestones/{id}
- Destructive
Delete project milestone
DELETE /project_milestones/{id}
Project milestone statuses
- Read
List project milestone statuses
GET /admin/project_milestone_statuses
- Read
Retrieve project milestone status
GET /admin/project_milestone_statuses/{id}
- Write
Create project milestone status
POST /admin/project_milestone_statuses
- Destructive
Sort project milestone statuses
Reorder the project milestone statuses. The order array should contain the status IDs in the desired order. Note that system statuses (Not Started, In Progress, Blocked, Done) have fixed positions relative to custom statuses.
- Destructive
Update project milestone status
PUT /admin/project_milestone_statuses/{id}
- Destructive
Delete project milestone status
Delete a custom project milestone status. System statuses (Not Started, In Progress, Blocked, Done) cannot be deleted and will return HTTP 403.
Project custom field groups
- Read
List project custom field groups
GET /admin/project_custom_field_groups
- Read
Retrieve project custom field group
GET /admin/project_custom_field_groups/{id}
- Write
Create project custom field group
POST /admin/project_custom_field_groups
- Destructive
Update project custom field group
PUT /admin/project_custom_field_groups/{id}
- Destructive
Delete project custom field group
DELETE /admin/project_custom_field_groups/{id}
Project custom field labels
- Read
List project custom field labels
Filtered request example — Date-type project custom fields: curl -g -H "Authorization: Bearer pcrmliveXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \ "https://api.pipelinecrm.com/api/v3/admin/projectcustomfieldlabels.json?conditions[customfieldlabelfieldtype]=date"
- Read
Retrieve project custom field label
GET /admin/project_custom_field_labels/{id}
- Write
Create project custom field label
POST /admin/project_custom_field_labels
- Destructive
Sort project custom field labels
Reorder the project custom field labels. The order array should contain the label IDs in the desired order.
- Destructive
Update project custom field label
PUT /admin/project_custom_field_labels/{id}
- Destructive
Delete project custom field label
DELETE /admin/project_custom_field_labels/{id}
Project templates
- Read
List project templates
Returns both account-specific and system-wide templates.
- Read
Retrieve project template
GET /admin/project_templates/{id}
- Write
Create project template
POST /admin/project_templates
- Destructive
Update project template
PUT /admin/project_templates/{id}
- Destructive
Delete project template
DELETE /admin/project_templates/{id}
Company custom field groups
- Read
List company custom field groups
GET /admin/company_custom_field_groups
- Read
Retrieve company custom field group
GET /admin/company_custom_field_groups/{id}
- Write
Create company custom field group
POST /admin/company_custom_field_groups
- Destructive
Update company custom field group
PUT /admin/company_custom_field_groups/{id}
- Destructive
Delete company custom field group
DELETE /admin/company_custom_field_groups/{id}
Company custom field labels
- Read
List company custom field labels
Filtered request example — Custom fields whose name contains Industry: curl -g -H "Authorization: Bearer pcrmliveXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \ "https://api.pipelinecrm.com/api/v3/admin/companycustomfieldlabels.json?conditions[customfieldlabelname]=Industry"
- Read
Retrieve company custom field label
GET /admin/company_custom_field_labels/{id}
- Write
Create company custom field label
POST /admin/company_custom_field_labels
- Destructive
Update company custom field label
PUT /admin/company_custom_field_labels/{id}
- Destructive
Delete company custom field label
DELETE /admin/company_custom_field_labels/{id}
Custom field label dropdown entries
- Read
List custom field label dropdown entries
Filtered request example — Dropdown entries of one custom field: curl -g -H "Authorization: Bearer pcrmliveXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \ "https://api.pipelinecrm.com/api/v3/admin/customfieldlabeldropdownentries.json?conditions[customfieldlabelid]=4821"
- Read
Retrieve custom field label dropdown entry
GET /admin/custom_field_label_dropdown_entries/{id}
- Write
Create custom field label dropdown entry
POST /admin/custom_field_label_dropdown_entries
- Destructive
Sort dropdown entries
Reorder the dropdown entries of one custom field.
- Destructive
Update custom field label dropdown entry
PUT /admin/custom_field_label_dropdown_entries/{id}
- Destructive
Delete custom field label dropdown entry
DELETE /admin/custom_field_label_dropdown_entries/{id}
Deal custom field groups
- Read
List deal custom field groups
GET /admin/deal_custom_field_groups
- Read
Retrieve deal custom field group
GET /admin/deal_custom_field_groups/{id}
- Write
Create deal custom field group
POST /admin/deal_custom_field_groups
- Destructive
Update deal custom field group
PUT /admin/deal_custom_field_groups/{id}
- Destructive
Delete deal custom field group
DELETE /admin/deal_custom_field_groups/{id}
Deal custom field labels
- Read
List deal custom field labels
Filtered request example — Dropdown custom fields in one group: curl -g -H "Authorization: Bearer pcrmliveXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \ "https://api.pipelinecrm.com/api/v3/admin/dealcustomfieldlabels.json?conditions[customfieldlabelfieldtype]=dropdown&conditions[cus…
- Read
Retrieve deal custom field label
GET /admin/deal_custom_field_labels/{id}
- Write
Create deal custom field label
POST /admin/deal_custom_field_labels
- Destructive
Sort deal custom fields
Reorder the deal custom fields as they appear in the app.
- Destructive
Update deal custom field label
PUT /admin/deal_custom_field_labels/{id}
- Destructive
Delete deal custom field label
DELETE /admin/deal_custom_field_labels/{id}
Deal loss reasons
- Read
List deal loss reasons
GET /admin/deal_loss_reasons
- Read
Retrieve deal loss reason
GET /admin/deal_loss_reasons/{id}
- Write
Create deal loss reason
POST /admin/deal_loss_reasons
- Destructive
Update deal loss reason
PUT /admin/deal_loss_reasons/{id}
- Destructive
Delete deal loss reason
DELETE /admin/deal_loss_reasons/{id}
Deal stages
- Read
List deal stages
GET /admin/deal_stages
- Read
Retrieve deal stage
GET /admin/deal_stages/{id}
- Write
Create deal stage
POST /admin/deal_stages
- Destructive
Sort deal stages
Reorder the stages of one pipeline. Stage percentages are redistributed to match the new order.
- Destructive
Update deal stage
PUT /admin/deal_stages/{id}
- Destructive
Delete deal stage
DELETE /admin/deal_stages/{id}
Deal statuses
- Read
List deal statuses
GET /admin/deal_statuses
- Read
Retrieve deal status
GET /admin/deal_statuses/{id}
- Write
Create deal status
POST /admin/deal_statuses
- Destructive
Update deal status
PUT /admin/deal_statuses/{id}
- Destructive
Delete deal status
DELETE /admin/deal_statuses/{id}
File (document) tags
- Read
List file tags
GET /admin/document_tags
- Read
Retrieve file tag
GET /admin/document_tags/{id}
- Write
Create file tag
POST /admin/document_tags
- Destructive
Update file tag
PUT /admin/document_tags/{id}
- Destructive
Delete file tag
DELETE /admin/document_tags/{id}
Event categories
- Read
List event categories
GET /admin/event_categories
- Read
Retrieve event category
GET /admin/event_categories/{id}
- Write
Create event category
POST /admin/event_categories
- Destructive
Update event category
PUT /admin/event_categories/{id}
- Destructive
Delete event category
DELETE /admin/event_categories/{id}
Lead sources
- Read
List lead sources
GET /admin/lead_sources
- Read
Retrieve lead source
GET /admin/lead_sources/{id}
- Write
Create lead source
POST /admin/lead_sources
- Destructive
Update lead source
PUT /admin/lead_sources/{id}
- Destructive
Delete lead source
DELETE /admin/lead_sources/{id}
Call dispositions
- Read
List call dispositions
Accounts that have never customised their dispositions are seeded with the defaults on first read.
- Read
Retrieve call disposition
GET /admin/call_outcomes/{id}
- Write
Create call disposition
POST /admin/call_outcomes
- Destructive
Reorder call dispositions
PUT /admin/call_outcomes/sort
- Destructive
Update call disposition
PUT /admin/call_outcomes/{id}
- Destructive
Delete call disposition
Call logs that referenced the disposition are left without one.
Lead statuses
- Read
List lead statuses
GET /admin/lead_statuses
- Read
Retrieve lead status
GET /admin/lead_statuses/{id}
- Write
Create lead status
POST /admin/lead_statuses
- Destructive
Update lead status
PUT /admin/lead_statuses/{id}
- Destructive
Delete lead status
DELETE /admin/lead_statuses/{id}
Calendar Event/Task Priorities
- Read
List Calendar Event/Task Priorities
GET /admin/calendar_entry_priorities
- Read
Retrieve Calendar Event/Task Priorities
GET /admin/calendar_entry_priorities/{id}
- Write
Create Calendar Event/Task Priorities
POST /admin/calendar_entry_priorities
- Destructive
Update Calendar Event/Task Priorities
PUT /admin/calendar_entry_priorities/{id}
- Destructive
Delete Calendar Event/Task Priorities
DELETE /admin/calendar_entry_priorities/{id}
Calendar Event/Task Statuses
- Read
List Calendar Event/Task Statuses
Retrieve all calendar entry statuses for the current account, ordered by position.
- Read
Retrieve Calendar Event/Task Status
GET /admin/calendar_entry_statuses/{id}
- Write
Create Calendar Event/Task Status
Create a new calendar entry status for the current account. New custom statuses are automatically inserted before the "Done" system status. The statustype field defaults to custom and cannot be set to todo or done (system statuses are automatically created per account).
- Destructive
Sort calendar entry statuses
Reorder the calendar entry statuses. The order array should contain the status IDs in the desired order.
- Destructive
Update Calendar Event/Task Status
Update a calendar entry status. Note: System statuses (To-Do and Done) have restrictions: - Their position cannot be changed (To-Do is always first, Done is always last) - Their statustype cannot be changed - Only name and hexcolor can be updated for system statuses
- Destructive
Delete Calendar Event/Task Status
Delete a calendar entry status. Note: System statuses (To-Do and Done with statustype: todo or done) cannot be deleted and will return 403 Forbidden.
Note categories
- Read
List note categories
GET /admin/note_categories
- Read
List system note categories
The built-in note categories every account has, as opposed to the ones an administrator created.
- Read
Retrieve note category
GET /admin/note_categories/{id}
- Write
Create note category
POST /admin/note_categories
- Destructive
Update note category
PUT /admin/note_categories/{id}
- Destructive
Delete note category
DELETE /admin/note_categories/{id}
Person custom field groups
- Read
List Person custom field groups
GET /admin/person_custom_field_groups
- Read
Retrieve person custom field group
GET /admin/person_custom_field_groups/{id}
- Write
Create person custom field group
POST /admin/person_custom_field_groups
- Destructive
Update person custom field group
PUT /admin/person_custom_field_groups/{id}
- Destructive
Delete person custom field group
DELETE /admin/person_custom_field_groups/{id}
Person custom field labels
- Read
List person custom field labels
Filtered request example — Custom fields whose name contains Region: curl -g -H "Authorization: Bearer pcrmliveXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \ "https://api.pipelinecrm.com/api/v3/admin/personcustomfieldlabels.json?conditions[customfieldlabelname]=Region"
- Read
Retrieve person custom field label
GET /admin/person_custom_field_labels/{id}
- Write
Create person custom field label
POST /admin/person_custom_field_labels
- Destructive
Update person custom field label
PUT /admin/person_custom_field_labels/{id}
- Destructive
Delete person custom field label
DELETE /admin/person_custom_field_labels/{id}
Predefined contacts tags
- Read
List predefined contacts tags
GET /admin/predefined_contacts_tags
- Read
Retrieve predefined contacts tag
GET /admin/predefined_contacts_tags/{id}
- Write
Create predefined contacts tag
POST /admin/predefined_contacts_tags
- Destructive
Update predefined contacts tag
PUT /admin/predefined_contacts_tags/{id}
- Destructive
Delete predefined contacts tag
DELETE /admin/predefined_contacts_tags/{id}
Performance lane
- Read
List performance lanes
GET /admin/product_lines
- Write
Create performance lane
POST /admin/product_lines
- Destructive
Update performance lane
PUT /admin/product_lines/{id}
- Destructive
Delete performance lane
DELETE /admin/product_lines/{id}
Revenue types
- Read
List revenue types
GET /admin/revenue_types
- Read
Retrieve revenue type
GET /admin/revenue_types/{id}
- Write
Create revenue type
POST /admin/revenue_types
- Destructive
Update revenue type
PUT /admin/revenue_types/{id}
- Destructive
Delete revenue type
DELETE /admin/revenue_types/{id}
Teams
- Read
List teams
GET /admin/teams
- Read
Retrieve team
GET /admin/teams/{id}
- Write
Create team
Description of levels: 1 for Basic, 2 for Manager, 3 for Executive. The non-name-related values shown are the defaults.
- Destructive
Update team
PUT /admin/teams/{id}
- Destructive
Delete team
DELETE /admin/teams/{id}
Todo templates
- Read
List todo templates
GET /admin/todo_templates
- Read
Retrieve todo template
GET /admin/todo_templates/{id}
- Write
Create todo template
POST /admin/todo_templates
- Destructive
Update todo template
PUT /admin/todo_templates/{id}
- Destructive
Delete todo template
DELETE /admin/todo_templates/{id}
Todo template items
- Read
List todo template items
GET /admin/todo_template_items
- Read
Retrieve todo template item
GET /admin/todo_template_items/{id}
- Write
Create todo template item
POST /admin/todo_template_items
- Destructive
Update todo template item
PUT /admin/todo_template_items/{id}
- Destructive
Delete todo template item
DELETE /admin/todo_template_items/{id}
Users
- Read
List users
GET /admin/users
- Read
Retrieve user
GET /admin/users/{id}
- Read
List visible users
The users this user can see. Any user may call it; /admin/users is the administrator view of the same data.
- Read
Retrieve user
GET /users/{id}
- Write
Create user
Description of levels: 1 for Basic, 2 for Manager, 3 for Executive. The non-name-related values shown are the defaults. Basic users and Managers must belong to a team, so when creating either a basic user or a manager, you have to include a teamid property.
- Destructive
Update user
PUT /admin/users/{id}
- Destructive
Delete user
DELETE /admin/users/{id}
API tokens
- Read
List API tokens
Every API token in the account, newest first, including revoked and expired ones: they stay as the record of a credential that once existed. The secret itself is never returned. tokenprefix is the visible start of the token, enough to match a row against a configuration file.
- Destructive
Revoke API token
Revokes the token: it stops authenticating immediately, and every other token keeps working. The row is kept as the audit trail, so the token still appears in the list with revokedat set.
Automations
- Read
List all webhooks
GET /admin/webhooks
- Write
Subscribe to webhooks
Subscribe to a webhook.
- Destructive
Unsubscribe from webhook
DELETE /admin/webhooks/{id}
Company tags
- Read
List company tags
GET /admin/company_tags
- Read
Retrieve Company tag
GET /admin/company_tags/{id}
- Write
Create company tag
POST /admin/company_tags
- Destructive
Update company tag
PUT /admin/company_tags/{id}
- Destructive
Delete company tag
DELETE /admin/company_tags/{id}
Deal tags
- Read
List deal tags
GET /admin/deal_tags
- Read
Retrieve Deal tag
GET /admin/deal_tags/{id}
- Write
Create deal tag
POST /admin/deal_tags
- Destructive
Update deal tag
PUT /admin/deal_tags/{id}
- Destructive
Delete deal tag
DELETE /admin/deal_tags/{id}
Project Associations
- Read
List project associations
Returns all associations for a project, optionally filtered by type.
- Write
Add a project association
Associates a deal, company, or person with the project. Idempotent — adding an existing association returns it without error.
- Destructive
Remove a project association
Removes a single association from the project.
Currencies
- Read
List currencies
All currencies Pipeline CRM supports. Not account-specific.
- Read
Retrieve currency
GET /currencies/{id}
Deal pipelines
- Read
List deal pipelines
GET /admin/deal_pipelines
- Read
Retrieve deal pipeline
GET /admin/deal_pipelines/{id}
- Write
Create deal pipeline
Requires the multiple-pipelines feature on the account. Marking a pipeline default clears the flag on the previous default.
- Destructive
Update deal pipeline
PUT /admin/deal_pipelines/{id}
- Destructive
Delete deal pipeline
A pipeline that still holds deals needs newpipelineid and newstageid: its deals are moved there first.
Deal won reasons
- Read
List deal won reasons
GET /admin/deal_won_reasons
- Read
Retrieve deal won reason
GET /admin/deal_won_reasons/{id}
- Write
Create deal won reason
POST /admin/deal_won_reasons
- Destructive
Update deal won reason
PUT /admin/deal_won_reasons/{id}
- Destructive
Delete deal won reason
DELETE /admin/deal_won_reasons/{id}
Message templates
- Read
List message templates
Email templates visible to you: your own plus shared ones.
- Read
Retrieve message template
GET /message_templates/{id}
Note templates
- Read
List note templates
GET /note_templates
- Read
Retrieve note template
GET /note_templates/{id}
Audits
- Read
List audits
The change history of records visible to you. Filtered request example — Every change to one deal in the last 30 days, newest first: curl -g -H "Authorization: Bearer pcrmliveXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \ "https://api.pipelinecrm.com/api/v3/audits.json?conditions[au…
Starred searches
- Read
List starred searches
The list views you have starred. Defaults to 5 per page.
- Read
Retrieve starred search
GET /starred_searches/{id}
No operations match.
See How connections work for access and permissions, or browse all integrations.