> ## Documentation Index
> Fetch the complete documentation index at: https://domoinc-openapi-sync-dataflows.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# PipelineDeals Connector

## Intro

PipelineDeals provides customer relationship management and sales CRM software to organize, track, and manage your deals, leads, and contacts. Use Domo's PipelineDeals connector to retrieve data about activities, tasks and events, companies, deals, documents and people. To learn more about the PipelineDeals API, visit their page ([https://app.pipelinedeals.com/api/docs/](https://app.pipelinedeals.com/api/docs/ "https://app.pipelinedeals.com/api/docs/") ).

You connect to your PipelineDeals account in the Data Center. This topic discusses the fields and menus that are specific to the PipelineDeals connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in [Adding a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").

## Prerequisites

To connect to your PipelineDeals account and create a DataSet, you must have a PipelineDeals API key. To find your API key, do the following:

1. Log into your CRM account.
2. Click **Account Settings**.
3. Click **Pipeline Deals API** in the sidebar.
4. Enable API access.

Your API key should now appear on the screen.

## Connecting to Your PipelineDeals Account

This section enumerates the options in the **Credentials** and **Details** panes in the PipelineDeals Connector page. The components of the other panes in this page, **Scheduling** and **Name & Describe Your DataSet**, are universal across most connector types and are discussed in greater length in [Adding a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").

### Credentials Pane

This pane contains fields for entering credentials to connect to your PipelineDeals account. The following table describes what is needed for each field:

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p><span class="s1"> Field </span></p></th><th colspan="1" rowspan="1"><p><span class="s1"> Description </span></p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> API Key </p></td><td colspan="1" rowspan="1"><p> Enter your PipelineDeals API key. For information about finding your API key, see "Prerequisites," above. </p></td></tr></tbody></table>

Once you have entered valid PipelineDeals credentials, you can use the same account any time you go to create a new PipelineDeals DataSet. You can manage connector accounts in the **Accounts** tab in the Data Center. For more information about this tab, see [Managing User Accounts for Connectors](/s/article/360042926054 "Managing User Accounts for Connectors").

### Details Pane

This pane contains a single menu from which you select a report type. No other parameters are required.

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p> Menu </p></th><th colspan="1" rowspan="1"><p> Description </p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> Report </p></td><td colspan="1" rowspan="1"><p> Select the PipelineDeals report you want to run. The following reports are available: </p><table border="1" cellpadding="1" cellspacing="1"><tbody><tr><td colspan="1" rowspan="1"><p> Activities </p></td><td colspan="1" rowspan="1"><p> Returns a list of all activities in your account. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Calendar Events and Tasks </p></td><td colspan="1" rowspan="1"><p> Returns a list of all calendar events and tasks in your account. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Companies </p></td><td colspan="1" rowspan="1"><p> Returns a list of companies in your account. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Deals </p></td><td colspan="1" rowspan="1"><p> Returns a list of deals in your account. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Deals Custom Field Labels </p></td><td colspan="1" rowspan="1"><p> Returns a list of deals custom field labels for your account. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Deals Details </p></td><td colspan="1" rowspan="1"><p> Returns detailed information about deals in your account. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Documents </p></td><td colspan="1" rowspan="1"><p> Returns a list of documents in your account. </p></td></tr><tr><td colspan="1" rowspan="1"><p> People </p></td><td colspan="1" rowspan="1"><p> Returns a list of people in your account. </p></td></tr></tbody></table></td></tr></tbody></table>

### Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see [Adding a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").