> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Pipeline CRM

> Integrate your application with the Pipeline CRM API

## 🚀 Quickstart

Connect to Pipeline CRM with Nango and see data flow in 2 minutes.

**1. Create the integration**

In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> *Configure New Integration* -> *Pipeline CRM*.

**2. Authorize Pipeline CRM**

Go to [Connections](https://app.nango.dev/dev/connections) -> *Add Test Connection* -> *Authorize*, then enter your **App Key** and **API Key**. See the [connect guide](https://nango.dev/docs/api-integrations/pipelinecrm/connect) for instructions on generating these credentials. Later, you'll let your users do the same directly from your app.

**3. Call the Pipeline CRM API**

Let's make your first request to the Pipeline CRM API (list deals). Replace the placeholders below with your [Environment API key](https://nango.dev/docs/reference/backend/http-api/api-keys.md), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections):

> [tab] cURL
>
> ```bash theme={null}
> curl "https://api.nango.dev/proxy/api/v3/deals.json" \
>   -H "Authorization: Bearer <NANGO-API-KEY>" \
>   -H "Provider-Config-Key: <INTEGRATION-ID>" \
>   -H "Connection-Id: <CONNECTION-ID>"
> ```

> [tab] Node
>
> Install Nango's backend SDK with `npm i @nangohq/node`. Then run:
>
> ```typescript theme={null}
> import { Nango } from '@nangohq/node';
>
> const nango = new Nango({ apiKey: '<NANGO-API-KEY>' });
>
> const res = await nango.get({
>     endpoint: '/api/v3/deals.json',
>     providerConfigKey: '<INTEGRATION-ID>',
>     connectionId: '<CONNECTION-ID>'
> });
>
> console.log(res.data);
> ```

Or fetch credentials with the [Node SDK](https://nango.dev/docs/reference/backend/backend-sdk/node.md#get-a-connection-with-credentials) or [API](https://nango.dev/docs/reference/backend/http-api/connections/get.md).

✅ You're connected! Check the [Logs](https://app.nango.dev/dev/logs) tab in Nango to inspect requests.

**4. Implement Nango in your app**

Follow our [quickstart](https://nango.dev/docs/getting-started/quickstart.md) to integrate Nango in your app.

To obtain your own credentials, follow the connect guide linked below.

## 📚 Pipeline CRM Integration Guides

* [How to connect Pipeline CRM (App Key & API Key)](https://nango.dev/docs/api-integrations/pipelinecrm/connect)\
  Generate an App Key and find your API Key from your Pipeline CRM admin settings.

Official docs: [Pipeline CRM API documentation](https://app.pipelinecrm.com/api/docs/introduction)

## 🧩 Pre-built syncs & tools for Pipeline CRM

Explore Nango-provided tools in your dashboard. [Extend and customize them](https://nango.dev/docs/implementation-guides/platform/functions/customize-template.md) to fit your needs.

### Others

| Function name | Description | Type |
| - | - | - |
| `create-calendar-entry` | Create a new task or event | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-comment` | Add a comment to a note. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-company` | Create a new company in Pipeline CRM. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-customer` | Mark a company as a customer (creates a Customer record tied to a company, tracking a health score). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-deal` | Create a new deal. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-document` | Attach a file to a deal, person, or company by URL. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-lead-source` | Create a new lead source. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-note` | Create a new note (activity) associated with a deal, person, or company. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-person` | Create a new person (contact) | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-team` | Create a new team. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-webhook` | Subscribe a URL to a webhook event (event\_model + event\_action combination). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-calendar-entry` | Delete a calendar entry. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-comment` | Delete a comment. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-company` | Delete a company. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-customer` | Remove a customer record from a company (does not delete the company itself). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-deal` | Delete a deal. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-document` | Delete a document. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-lead-source` | Delete a lead source. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-note` | Delete a note. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-person` | Delete a person. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-team` | Delete a team. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-account-notification` | Get a single account notification by id. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-calendar-entry` | Get a single calendar entry (task or event) by id. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-company` | Get a single company by id. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-deal` | Get a single deal by id. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-document` | Get a single document by id. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-note` | Get a single note by id. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-person` | Get a single person by id. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-profile` | Get the profile of the user this API key belongs to. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-team` | Get a single team by id. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-user` | Get a single user by id. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-account-notifications` | List system-generated account notifications for the authenticated user. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-calendar-entries` | List calendar entries — a unified model covering both Tasks and Events. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-calendar-entry-priorities` | List priority levels that can be assigned to a calendar entry. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-calendar-entry-statuses` | List statuses that can be assigned to a calendar entry. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-comments` | List comments on a note. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-companies` | List companies in this account. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-company-custom-field-groups` | List custom field groups defined for companies. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-company-custom-field-labels` | List individual custom field definitions available on companies. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-company-tags` | List tags available for tagging companies. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-custom-field-dropdown-entries` | List the picklist option values for dropdown-type custom fields. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-deal-custom-field-groups` | List custom field groups defined for deals. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-deal-custom-field-labels` | List individual custom field definitions available on deals. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-deal-loss-reasons` | List reasons that can be assigned when marking a deal lost. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-deal-pipelines` | List deal pipelines configured on this account. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-deal-stages` | List deal stages (steps within a pipeline) configured on this account. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-deal-statuses` | List deal statuses configured on this account. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-deal-tags` | List tags available for tagging deals. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-deal-won-reasons` | List reasons that can be assigned when marking a deal won. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-deals` | List deals in this account. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-document-tags` | List tags available for tagging documents/files. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-documents` | List documents (called "Files" in the Pipeline CRM UI) attached to deals/people/companies/calendar entries. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-event-categories` | List categories that can be assigned to a calendar entry (task or event). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-lead-sources` | List lead sources (how a person/deal originated) configured on this account. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-lead-statuses` | List lead statuses configured for People records. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-note-categories` | List categories that can be assigned to a note (activity). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-notes` | List notes (activities) scoped to a deal, person, company, or across the account. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-people` | List people (contacts/leads) in this account. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-person-custom-field-groups` | List custom field groups defined for people. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-person-custom-field-labels` | List individual custom field definitions available on people. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-person-tags` | List predefined tags available for tagging people/contacts. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-product-lines` | List product lines configured on this account for tagging deals, people, and companies. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-revenue-types` | List revenue types (e.g. New, Renewal) that can be assigned to a deal. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-teams` | List teams in this account. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-users` | List users (team members) in this account. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-webhooks` | List webhook subscriptions configured on this account. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-account-notification` | Mark an account notification as seen/read. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-calendar-entry` | Update a calendar entry, e.g. mark a task complete. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-comment` | Update an existing comment. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-company` | Update fields on an existing company | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-customer` | Update a customer record (e.g. reassign owner). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-deal` | Update fields on an existing deal. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-document` | Update a document's title or re-point it to a new file URL. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-lead-source` | Update a lead source. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-note` | Update the content of an existing note. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-person` | Update fields on an existing person. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-team` | Update a team's name. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-user` | Update fields on an existing user. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `calendar_entries` | Sync calendar entries (Tasks + Events) across the account | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `companies` | Sync companies in this account. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `deals` | Sync deals in this account. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `documents` | Sync documents (files) attached to deals/people/companies/calendar entries. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `notes` | Sync notes (called Activities in the Pipeline CRM UI) across deals/people/companies | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `people` | Sync people (contacts/leads) in this account. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `teams` | Sync teams in this account. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `users` | Sync users (team members) in this account | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.