Pipeline CRM API Documentation
This is the complete API documentation for connecting to the Pipeline CRM API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet Pipeline CRM: Manage Pipeline CRM deals, people, companies, tasks, and activities. Keep reading to get started.
Quickstart
Before you run your first Pipeline CRM request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one Pipeline CRM connection — create or choose one in Connections. Note its
connectionId.
Every Pipeline CRM action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/pipelineCRM/actions/{actionSlug}/runYou need a MindCloud API Key and a Pipeline CRM connection. Then call an action such as List Activities:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/pipelineCRM/actions/list-activities/run" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"connectionId": "$CONNECTION_ID",
"arguments": {}
}'Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authenticate with a MindCloud API Key plus a connectionId for your Pipeline CRM account. See Pipeline CRM API Authentication for the full flow and how to get your connection credentials.
Pipeline CRM actions
All 24 published actions for this Pipeline CRM version. Each page documents the endpoint, arguments, and response controls.
- POSTCreate Activity
- POSTCreate Calendar Entry
- POSTCreate Company
- POSTCreate Deal
- POSTCreate Person
- DELETEDelete Calendar Entry
- DELETEDelete Company
- DELETEDelete Deal
- DELETEDelete Person
- GETList Activities
- GETList Calendar Entries
- GETList Companies
- GETList Deals
- GETList People
- GETRetrieve Activity
- GETRetrieve Calendar Entry
- GETRetrieve Company
- GETRetrieve Deal
- GETRetrieve Person
- PUTUpdate Activity
- PUTUpdate Calendar Entry
- PUTUpdate Company
- PUTUpdate Deal
- PUTUpdate Person
Related apps
More Sales & CRM apps on the Universal API, behind the same REST shape. Or browse all apps.