---
canonical_url: "https://docs.composio.dev/toolkits/pitchbook"
markdown_url: "https://docs.composio.dev/toolkits/pitchbook.md"
product: "platform"
version: null
last_updated: null
---

# PitchBook

PitchBook provides private-market data on companies, deals, funds, investors, people, and service providers through its contracted REST API.

- **Category:** business intelligence
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 130
- **Triggers:** 0
- **Slug:** `PITCHBOOK`
- **Version:** 00000000_00

## Tools

### Download Credit News Attachment

**Slug:** `PITCHBOOK_DOWNLOAD_CREDIT_NEWS_ATTACHMENT`

Download an attachment for a specific PitchBook credit-news article.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Attachment filename from the article metadata. |
| `article_id` | integer | Yes | Credit-news article ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Credit Research

**Slug:** `PITCHBOOK_DOWNLOAD_CREDIT_RESEARCH`

Download an exact file for a PitchBook credit-research report.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_name` | string | Yes | Report filename. |
| `file_type` | string | Yes | Report file type. |
| `report_id` | integer | Yes | Credit-research report ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Entity Profile Download

**Slug:** `PITCHBOOK_DOWNLOAD_ENTITY_PROFILE`

Download a PitchBook entity profile as a PDF file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_type` | string ("COMPANY" | "INVESTOR" | "LIMITED_PARTNER" | "SERVICE_PROVIDER" | "FUND" | "PERSON") | No | Entity type to render in the PDF. |
| `pitchbook_id` | string | Yes | PitchBook entity ID. |
| `exclude_sections` | string | No | Sections to exclude from the PDF; do not combine with include_sections. |
| `include_sections` | string | No | Sections to include in the PDF; do not combine with exclude_sections. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patent File Download

**Slug:** `PITCHBOOK_DOWNLOAD_PATENT`

Download the exact file for a specific patent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `patent_id` | string | Yes | Patent ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Limits

**Slug:** `PITCHBOOK_GET_ACCOUNT_LIMITS`

Return the connected PitchBook account's current limit values and remaining limits for today.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Company All Investors

**Slug:** `PITCHBOOK_GET_ALL_COMPANY_INVESTORS`

Retrieves current and former investors of the specific company

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Company pbId |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Active Investments

**Slug:** `PITCHBOOK_GET_BULK_ACTIVE_INVESTMENTS`

Retrieves active investments for multiple investors in one bulk read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | PitchBook IDs to retrieve in one bulk request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Company All Investors

**Slug:** `PITCHBOOK_GET_BULK_ALL_COMPANY_INVESTORS`

Retrieves current and former investors of the specific company. This bulk call allows you to send multiple pbIds within a single API call. When Subscription per-item charging is enabled for the account, each newly retrieved item consumes credits at the same rate as the equivalent individual GET call; if the remaining balance is insufficient for the whole request, the call returns 402 and no data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | PitchBook IDs to retrieve in this bulk read. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bulk Company

**Slug:** `PITCHBOOK_GET_BULK_COMPANY`

Retrieves all the data points about specific company. This bulk call allows you to send multiple pbIds within a single API call. When Subscription per-item charging is enabled for the account, each newly retrieved item consumes credits at the same rate as the equivalent individual GET call; if the remaining balance is insufficient for the whole request, the call returns 402 and no data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | PitchBook IDs to retrieve in this bulk read. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bulk Company Active Investors

**Slug:** `PITCHBOOK_GET_BULK_COMPANY_ACTIVE_INVESTORS`

Retrieves active investors of the specific company. This bulk call allows you to send multiple pbIds within a single API call. When Subscription per-item charging is enabled for the account, each newly retrieved item consumes credits at the same rate as the equivalent individual GET call; if the remaining balance is insufficient for the whole request, the call returns 402 and no data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | PitchBook IDs to retrieve in this bulk read. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Company Bio

**Slug:** `PITCHBOOK_GET_BULK_COMPANY_BIO`

Retrieves key data points about specific company. This bulk call allows you to send multiple pbIds within a single API call. When Subscription per-item charging is enabled for the account, each newly retrieved item consumes credits at the same rate as the equivalent individual GET call; if the remaining balance is insufficient for the whole request, the call returns 402 and no data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | PitchBook IDs to retrieve in this bulk read. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bulk Company Industries

**Slug:** `PITCHBOOK_GET_BULK_COMPANY_INDUSTRIES`

Retrieves industries and verticals tagged to the specific company. This bulk call allows you to send multiple pbIds within a single API call. When Subscription per-item charging is enabled for the account, each newly retrieved item consumes credits at the same rate as the equivalent individual GET call; if the remaining balance is insufficient for the whole request, the call returns 402 and no data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | PitchBook IDs to retrieve in this bulk read. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bulk Company Most Recent Financing

**Slug:** `PITCHBOOK_GET_BULK_COMPANY_MOST_RECENT_FINANCING`

Retrieves key data for the most recent financing deal of the specific company. This bulk call allows you to send multiple pbIds within a single API call. When Subscription per-item charging is enabled for the account, each newly retrieved item consumes credits at the same rate as the equivalent individual GET call; if the remaining balance is insufficient for the whole request, the call returns 402 and no data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | PitchBook IDs to retrieve in this bulk read. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bulk Credit News

**Slug:** `PITCHBOOK_GET_BULK_CREDIT_NEWS`

Retrieve full information for multiple credit-news article IDs in one call.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Article IDs to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bulk Entity Affiliates

**Slug:** `PITCHBOOK_GET_BULK_ENTITY_AFFILIATES`

Retrieve affiliate lists for multiple PitchBook entities.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Entity IDs to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Entity Bio

**Slug:** `PITCHBOOK_GET_BULK_ENTITY_BIO`

Retrieve biography data for multiple PitchBook entity IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Entity IDs to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Entity Locations

**Slug:** `PITCHBOOK_GET_BULK_ENTITY_LOCATIONS`

Retrieve location data for multiple PitchBook entities.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Entity IDs to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Entity People

**Slug:** `PITCHBOOK_GET_BULK_ENTITY_PEOPLE`

Retrieve team-member data for multiple PitchBook entities.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Entity IDs to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bulk Fund Bio

**Slug:** `PITCHBOOK_GET_BULK_FUND_BIO`

Retrieve key data points for multiple funds in one read-only bulk request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Funds to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Investment Preferences

**Slug:** `PITCHBOOK_GET_BULK_INVESTMENT_PREFERENCES`

Retrieves investment preferences for multiple investors in one bulk read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | PitchBook IDs to retrieve in one bulk request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Investor

**Slug:** `PITCHBOOK_GET_BULK_INVESTOR`

Retrieves all data points for multiple investors in one bulk read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | PitchBook IDs to retrieve in one bulk request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Investor Bio

**Slug:** `PITCHBOOK_GET_BULK_INVESTOR_BIO`

Retrieves key data points for multiple investors in one bulk read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | PitchBook IDs to retrieve in one bulk request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Investor Funds

**Slug:** `PITCHBOOK_GET_BULK_INVESTOR_FUNDS`

Retrieves open and closed funds for multiple investors in one bulk read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | PitchBook IDs to retrieve in one bulk request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Limited Partner

**Slug:** `PITCHBOOK_GET_BULK_LIMITED_PARTNER`

Retrieves all data points for multiple limited partners in one bulk read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | PitchBook IDs to retrieve in one request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Limited Partner Bio

**Slug:** `PITCHBOOK_GET_BULK_LIMITED_PARTNER_BIO`

Retrieves bios for multiple limited partners in one bulk read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | PitchBook IDs to retrieve in one request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Limited Partner Target Allocations

**Slug:** `PITCHBOOK_GET_BULK_LIMITED_PARTNER_TARGET_ALLOCATIONS`

Retrieves target allocations for multiple limited partners in one bulk read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | PitchBook IDs to retrieve in one request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Limited Partner Commitment Aggregates

**Slug:** `PITCHBOOK_GET_BULK_LP_COMMITMENT_AGGREGATES`

Retrieves commitment aggregates for multiple limited partners in one bulk read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | PitchBook IDs to retrieve in one request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk People Bio

**Slug:** `PITCHBOOK_GET_BULK_PERSON_BIO`

Retrieves biographies for multiple people in one read request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | PitchBook IDs to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk Service Provider Bio

**Slug:** `PITCHBOOK_GET_BULK_SERVICE_PROVIDER_BIO`

Retrieves biographies for multiple service providers in one read request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | PitchBook IDs to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Company

**Slug:** `PITCHBOOK_GET_COMPANY`

Return all documented PitchBook data points for one company by its PitchBook ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Company PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Company Active Investors

**Slug:** `PITCHBOOK_GET_COMPANY_ACTIVE_INVESTORS`

Retrieves active investors of the specific company

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Company pbId |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Company Bio

**Slug:** `PITCHBOOK_GET_COMPANY_BIO`

Retrieves key data points about specific company

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Company pbId |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Company Deals

**Slug:** `PITCHBOOK_GET_COMPANY_DEALS`

Retrieves all deals of the specific company

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Company pbId |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Company Deal Service Providers

**Slug:** `PITCHBOOK_GET_COMPANY_DEAL_SERVICE_PROVIDERS`

Retrieves service providers that serviced deals of the specific company

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Company pbId |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Company General Service Providers

**Slug:** `PITCHBOOK_GET_COMPANY_GENERAL_SERVICE_PROVIDERS`

Retrieves current and former general service providers of the specific company

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Company pbId |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Company Industry

**Slug:** `PITCHBOOK_GET_COMPANY_INDUSTRY`

Retrieves industries, verticals, keywords, and emerging spaces tagged to the specific company

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Company pbId |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Company Most Recent Debt Financing

**Slug:** `PITCHBOOK_GET_COMPANY_MOST_RECENT_DEBT_FINANCING`

Retrieve the most recent debt financing for a company PitchBook ID, including its debt and lender data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Company PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Company Most Recent Financing

**Slug:** `PITCHBOOK_GET_COMPANY_MOST_RECENT_FINANCING`

Retrieves key data for the most recent financing deal of the specific company

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Company pbId |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Company Social Analytics

**Slug:** `PITCHBOOK_GET_COMPANY_SOCIAL_ANALYTICS`

Retrieves social media and web signal data points of the specified company

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `compare` | string ("SIMILAR_COMPANIES" | "INDUSTRY" | "VERTICALS" | "ALL_COMPANIES") | No | Compare social media and web signals data against companies within similar companies (SIMILAR_COMPANIES), industry (INDUSTRY), verticals (VERTICALS), or all companies (ALL_COMPANIES). |
| `pitchbook_id` | string | Yes | Company pbId |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Company Profile Updates

**Slug:** `PITCHBOOK_GET_COMPANY_UPDATES`

Retrieves changes for the specific company for up to the last 90 days

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since_date` | string | No | Add this parameter to extract information about the entity updates after a certain date with the > operator, before a certain date with the < operator and between 2 dates with the ^ operator. Set this parameter in pair with pbId. Format: YYYY-MM-DD |
| `pitchbook_id` | string | Yes | Company pbId. Required to specify time period using 'sinceDate' or 'trailingRange' parameter |
| `trailing_range` | integer | No | Add this parameter to extract information about the entity updates during last N days (up to 90). Set this parameter in pair with pbId |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Company VC Exit Predictions

**Slug:** `PITCHBOOK_GET_COMPANY_VC_EXIT_PREDICTIONS`

For a given pbId, returns exit predictions based on PitchBook machine learning. Company needs to have at least 2 rounds of funding in the past six years to qualify for this dataset. For detailed methodology explanation, please reference this document .

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Company pbId |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Contracts History

**Slug:** `PITCHBOOK_GET_CONTRACTS_HISTORY`

Retrieve contracts within the connected PitchBook account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `active_contract` | string | No | Return active contracts with TRUE, past contracts with FALSE, or omit for all contracts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Credit News

**Slug:** `PITCHBOOK_GET_CREDIT_NEWS_BY_ID`

Retrieve full article content for a specific PitchBook credit-news article.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `article_id` | integer | Yes | Credit-news article ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Credits History

**Slug:** `PITCHBOOK_GET_CREDITS_BALANCE_STATE_BY_PERIOD`

Retrieve PitchBook credit usage for a timeframe of up to 90 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since_date` | string | No | Date filter using >, <, or ^ between two YYYY-MM-DD dates, up to the last 90 days. |
| `trailing_range` | integer | No | Number of trailing days to include. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Deal Bio

**Slug:** `PITCHBOOK_GET_DEAL_BIO`

Retrieve key data points for a deal by its PitchBook ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Deal PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Deal Cap Table History

**Slug:** `PITCHBOOK_GET_DEAL_CAP_TABLE_HISTORY`

Retrieve cap-table history for a deal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Deal PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Deal Debt and Lenders

**Slug:** `PITCHBOOK_GET_DEAL_DEBT_LENDERS`

Retrieve debt instruments and lenders for a deal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Deal PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Deal Details

**Slug:** `PITCHBOOK_GET_DEAL_DETAILS`

Return the extended documented details for one deal by its PitchBook ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Deal PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Deal Investors and Exiters

**Slug:** `PITCHBOOK_GET_DEAL_INVESTORS_EXITERS`

Retrieve investors, sellers, and exiters for a deal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Deal PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Deal Multiples

**Slug:** `PITCHBOOK_GET_DEAL_MULTIPLES`

Retrieve transaction and valuation multiples for a deal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Deal PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Deal Service Providers

**Slug:** `PITCHBOOK_GET_DEAL_SERVICE_PROVIDERS`

Retrieve service providers associated with a deal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Deal PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Deal Stock Information

**Slug:** `PITCHBOOK_GET_DEAL_STOCK_INFO`

Retrieve stock terms and share information for a deal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Deal PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Deal Tranche Information

**Slug:** `PITCHBOOK_GET_DEAL_TRANCHE_INFO`

Retrieve tranche information for a deal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Deal PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Deal Updates

**Slug:** `PITCHBOOK_GET_DEAL_UPDATES`

Retrieve indicators of which deal datasets changed during a time period.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since_date` | string | No | Date filter using >, <, or ^ with YYYY-MM-DD. |
| `pitchbook_id` | string | Yes | Deal PitchBook ID. |
| `trailing_range` | integer | No | Number of trailing days to inspect, up to 90. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Deal Valuation

**Slug:** `PITCHBOOK_GET_DEAL_VALUATION`

Retrieve valuation information for a deal by its PitchBook ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Deal PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cost of Calls

**Slug:** `PITCHBOOK_GET_ENABLED_CALLS_INFO`

Retrieve pricing details for each enabled PitchBook endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pricing_model` | string ("SUBSCRIPTION" | "PAY_PER_CALL" | "INTEGRATION") | Yes | Account pricing model whose enabled endpoint costs should be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Usage Report

**Slug:** `PITCHBOOK_GET_ENDPOINT_USAGE_REPORT`

Retrieve PitchBook API calls made during a timeframe of up to 30 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since_date` | string | No | Date filter using >, <, or ^ between two YYYY-MM-DD dates, up to the last 30 days. |
| `trailing_range` | integer | No | Number of trailing days to include. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Entity Affiliates

**Slug:** `PITCHBOOK_GET_ENTITY_AFFILIATES`

Retrieve parent, subsidiary, and sister entities affiliated with an entity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | PitchBook entity ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Entity Bio

**Slug:** `PITCHBOOK_GET_ENTITY_BIO`

Retrieve biography data for an entity's primary PitchBook type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | PitchBook entity ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Entity Locations

**Slug:** `PITCHBOOK_GET_ENTITY_LOCATIONS`

Retrieve headquarters and alternate offices for a PitchBook entity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | PitchBook entity ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Entity News

**Slug:** `PITCHBOOK_GET_ENTITY_NEWS`

Retrieve news articles for a PitchBook entity from up to the last 30 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since_date` | string | No | Date expression selecting articles by publication date. |
| `pitchbook_id` | string | Yes | PitchBook entity ID. |
| `trailing_range` | string | No | Number of trailing days to return, up to 30. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Entity People

**Slug:** `PITCHBOOK_GET_ENTITY_PEOPLE`

Retrieve team-member data for a PitchBook entity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | PitchBook entity ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### General Updates

**Slug:** `PITCHBOOK_GET_ENTITY_UPDATES`

Retrieve changes for a PitchBook entity from up to the last 90 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since_date` | string | No | Date expression selecting updates by date. |
| `pitchbook_id` | string | Yes | PitchBook entity ID. |
| `trailing_range` | integer | No | Number of trailing days to return, up to 90. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fund Active Investments

**Slug:** `PITCHBOOK_GET_FUND_ACTIVE_INVESTMENTS`

Retrieve active investments for a fund by its PitchBook ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Fund PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fund Benchmark

**Slug:** `PITCHBOOK_GET_FUND_BENCHMARK`

Retrieve benchmark values for a fund by its PitchBook ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Fund PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fund Bio

**Slug:** `PITCHBOOK_GET_FUND_BIO`

Return the documented key data points for one fund by its PitchBook ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Fund PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fund Cash Flows

**Slug:** `PITCHBOOK_GET_FUND_CASH_FLOWS`

Retrieve fund cash-flow data across supported reporting periods.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since_date` | string | No | Fiscal period date filter using >, <, or ^ with YYYY-MM-DD. |
| `period_type` | string ("MTH" | "QTR" | "ANN") | No | Reporting period type. |
| `pitchbook_id` | string | Yes | Fund PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fund Cash Flows (Legacy)

**Slug:** `PITCHBOOK_GET_FUND_CASH_FLOWS_LEGACY`

Retrieve contributed and distributed amounts for a fund and reporting period using the legacy endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `period` | string | Yes | Cash-flow period. |
| `pitchbook_id` | string | Yes | Fund PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fund Commitments

**Slug:** `PITCHBOOK_GET_FUND_COMMITMENTS`

Retrieve limited-partner commitments for a fund.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Fund PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fund Investment Preferences

**Slug:** `PITCHBOOK_GET_FUND_INVESTMENT_PREFERENCES`

Retrieve documented investment preferences for a fund.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Fund PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fund Investments

**Slug:** `PITCHBOOK_GET_FUND_INVESTMENTS`

Retrieve active and former investments for a fund.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Fund PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fund People

**Slug:** `PITCHBOOK_GET_FUND_PEOPLE`

Retrieve active and former team members for a fund.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Fund PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fund Performance

**Slug:** `PITCHBOOK_GET_FUND_PERFORMANCE`

Retrieve current and optionally historical performance metrics for a fund.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since_date` | string | No | Historical period date filter using >, <, or ^ with YYYY-MM-DD. |
| `pitchbook_id` | string | Yes | Fund PitchBook ID. |
| `historical_performance` | boolean | No | Whether to include historical performance snapshots. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fund Service Providers

**Slug:** `PITCHBOOK_GET_FUND_SERVICE_PROVIDERS`

Retrieve service providers for a fund.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Fund PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fund Share Classes

**Slug:** `PITCHBOOK_GET_FUND_SHARE_CLASSES`

Retrieve share-class-level fees and expenses for a fund.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Fund PitchBook ID. |
| `share_class_id` | string | No | Share class identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fund Share Classes Performance

**Slug:** `PITCHBOOK_GET_FUND_SHARE_CLASSES_PERFORMANCE`

Retrieve latest share-class-level performance snapshots for a fund.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Fund PitchBook ID. |
| `share_class_id` | string | No | Share class identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fund Profile Updates

**Slug:** `PITCHBOOK_GET_FUND_UPDATE_CHANGES`

Retrieve profile changes for a fund from up to the last 90 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since_date` | string | No | Update date filter using >, <, or ^ with YYYY-MM-DD. |
| `pitchbook_id` | string | Yes | Fund PitchBook ID. |
| `trailing_range` | integer | No | Number of trailing days to inspect, up to 90. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Investor

**Slug:** `PITCHBOOK_GET_INVESTOR`

Return all documented PitchBook data points for one investor by its PitchBook ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Investor PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Investor Active Investments

**Slug:** `PITCHBOOK_GET_INVESTOR_ACTIVE_INVESTMENTS`

Retrieves active investments of a specific investor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Investor PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Investor Bio

**Slug:** `PITCHBOOK_GET_INVESTOR_BIO`

Retrieves key data points about a specific investor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Investor PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Investor Board Seats

**Slug:** `PITCHBOOK_GET_INVESTOR_BOARD_SEATS`

Retrieves current and former board seats of a specific investor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Investor PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Investor Completed Investments

**Slug:** `PITCHBOOK_GET_INVESTOR_COMPLETED_INVESTMENTS`

Retrieves completed investments of a specific investor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Investor PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Investor Deal Service Providers

**Slug:** `PITCHBOOK_GET_INVESTOR_DEAL_SERVICE_PROVIDERS`

Retrieves service providers that serviced deals of a specific investor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Investor PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Investor Funds

**Slug:** `PITCHBOOK_GET_INVESTOR_FUNDS`

Retrieves open and closed funds managed by a specific investor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Investor PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Investor General Service Providers

**Slug:** `PITCHBOOK_GET_INVESTOR_GENERAL_SERVICE_PROVIDERS`

Retrieves current and former general service providers of a specific investor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Investor PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Investor Investment Preferences

**Slug:** `PITCHBOOK_GET_INVESTOR_INVESTMENT_PREFERENCES`

Retrieves key investment preferences of a specific investor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Investor PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Investor Last Closed Fund

**Slug:** `PITCHBOOK_GET_INVESTOR_LAST_CLOSED_FUND`

Retrieves key data about the last closed fund of a specific investor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Investor PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Investor Profile Updates

**Slug:** `PITCHBOOK_GET_INVESTOR_UPDATES`

Retrieves changes for a specific investor for up to the last 90 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since_date` | string | No | Return updates after (>), before (<), or between (^) dates in YYYY-MM-DD format. |
| `pitchbook_id` | string | Yes | Investor PitchBook ID. |
| `trailing_range` | integer | No | Return updates from the last N days, up to 90. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Limited Partner

**Slug:** `PITCHBOOK_GET_LIMITED_PARTNER`

Retrieves all documented data points about a specific limited partner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Limited partner PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Limited Partner Actual Allocations

**Slug:** `PITCHBOOK_GET_LIMITED_PARTNER_ACTUAL_ALLOCATIONS`

Retrieves current asset allocations of a specific limited partner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Limited partner PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Limited Partner Bio

**Slug:** `PITCHBOOK_GET_LIMITED_PARTNER_BIO`

Retrieves key data points about a specific limited partner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Limited partner PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Limited Partner Commitment Aggregates

**Slug:** `PITCHBOOK_GET_LIMITED_PARTNER_COMMITMENT_AGGREGATES`

Retrieves active and total commitment aggregates of a specific limited partner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Limited partner PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Limited Partner Commitment Preferences

**Slug:** `PITCHBOOK_GET_LIMITED_PARTNER_COMMITMENT_PREFERENCES`

Retrieves investment preferences of a specific limited partner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Limited partner PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Limited Partner Commitments

**Slug:** `PITCHBOOK_GET_LIMITED_PARTNER_COMMITMENTS`

Retrieves detailed commitments for a specific limited partner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Limited partner PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Limited Partner Service Providers

**Slug:** `PITCHBOOK_GET_LIMITED_PARTNER_SERVICE_PROVIDERS`

Retrieves current and former service providers of a specific limited partner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Limited partner PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Limited Partner Target Allocations

**Slug:** `PITCHBOOK_GET_LIMITED_PARTNER_TARGET_ALLOCATIONS`

Retrieves target asset allocations of a specific limited partner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Limited partner PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Limited Partner Profile Updates

**Slug:** `PITCHBOOK_GET_LIMITED_PARTNER_UPDATES`

Retrieves changes for a specific limited partner for up to the last 90 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since_date` | string | No | Return updates after (>), before (<), or between (^) dates in YYYY-MM-DD format. |
| `pitchbook_id` | string | Yes | Limited partner PitchBook ID. |
| `trailing_range` | integer | No | Return updates from the last N days, up to 90. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Lookup Tables

**Slug:** `PITCHBOOK_GET_LOOKUP_TABLES`

Return PitchBook lookup codes used by search endpoint parameters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `table_names` | array | No | Lookup-table names to return; omit to return all tables. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Lookup Tables Structure

**Slug:** `PITCHBOOK_GET_LOOKUP_TABLES_STRUCTURE`

Return lookup tables used by PitchBook search endpoints.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Most Recent Credit News

**Slug:** `PITCHBOOK_GET_MOST_RECENT_CREDIT_NEWS`

Retrieve up to 250 of the most recently published credit-news articles without full article content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page number. |
| `cursor` | string | No | Cursor from a previous response; omit for the first page. |
| `per_page` | integer | No | Results per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Most Recent Private Company Financials

**Slug:** `PITCHBOOK_GET_MOST_RECENT_PRIVATE_COMPANY_FINANCIALS`

Retrieves financial data for the most recent available fiscal year or quarter of the specific company. Data is returned on an annual basis by default. Endpoint is only available for private companies

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `period_type` | string | No | Type of the period in which data will be presented. The list of types could be found here |
| `pitchbook_id` | string | Yes | Company pbId |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patent Detailed

**Slug:** `PITCHBOOK_GET_PATENT_DETAILED`

Retrieve the extended description of a specific patent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `patent_id` | string | Yes | Patent ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### People Bio

**Slug:** `PITCHBOOK_GET_PERSON`

Retrieves key data points about a specific person.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Person PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### People Contact

**Slug:** `PITCHBOOK_GET_PERSON_CONTACT_INFO`

Retrieves contact information for a specific person.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Person PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### People Education/Work

**Slug:** `PITCHBOOK_GET_PERSON_EDUCATION_WORK`

Retrieves company, deal, fund, education, board, and advisory roles for a person.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Person PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Person Profile Updates

**Slug:** `PITCHBOOK_GET_PERSON_UPDATES`

Retrieves changes for a specific person for up to the last 90 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since_date` | string | No | Updates after (>), before (<), or between (^) YYYY-MM-DD dates. |
| `pitchbook_id` | string | Yes | Person PitchBook ID. |
| `trailing_range` | integer | No | Updates from the last N days, up to 90. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fund Portfolio Holdings

**Slug:** `PITCHBOOK_GET_PORTFOLIO_HOLDINGS`

Retrieve portfolio holdings for a fund and reporting period.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `period` | string | Yes | Reported holdings period. |
| `syndicated` | string | No | Whether to select syndicated-loan holdings. |
| `pitchbook_id` | string | Yes | Fund PitchBook ID. |
| `industry_code` | string | No | Comma-separated industry codes. |
| `instrument_type` | string | No | Comma-separated instrument types. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Private Company Financials

**Slug:** `PITCHBOOK_GET_PRIVATE_COMPANY_FINANCIALS`

Retrieves private company financial data for all available fiscal years or quarters. Annual data is returned by default. Endpoint is only available for private companies.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since_date` | string | No | Search for financial data relating to the fiscal period after a certain date using the > operator, before a certain date using the < operator, and between 2 dates using the ^ operator. Format: YYYY-MM-DD |
| `period_type` | string | No | Type of the period in which data will be presented. The list of types could be found here |
| `pitchbook_id` | string | Yes | Company pbId |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Sandbox Entities

**Slug:** `PITCHBOOK_GET_SANDBOX_ENTITIES`

Return entities available for testing with a PitchBook sandbox API key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_type` | string ("COMPANIES" | "INVESTORS" | "LIMITED_PARTNERS" | "SERVICE_PROVIDERS" | "PEOPLE" | "DEALS" | "FUNDS" | "CREDIT_NEWS") | No | Entity type to return; omit to return every sandbox entity type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Serviced Companies

**Slug:** `PITCHBOOK_GET_SERVICED_COMPANIES`

Retrieves current and former services provided to companies by a service provider.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Service provider PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Serviced Deals

**Slug:** `PITCHBOOK_GET_SERVICED_DEALS`

Retrieves general data about deals serviced by a service provider.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Service provider PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Serviced Funds

**Slug:** `PITCHBOOK_GET_SERVICED_FUNDS`

Retrieves current and former services provided to funds by a service provider.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Service provider PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Serviced Investors

**Slug:** `PITCHBOOK_GET_SERVICED_INVESTORS`

Retrieves current and former services provided to investors by a service provider.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Service provider PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Serviced Limited Partners

**Slug:** `PITCHBOOK_GET_SERVICED_LIMITED_PARTNERS`

Retrieves current and former services provided to limited partners by a service provider.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Service provider PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Service Provider Bio

**Slug:** `PITCHBOOK_GET_SERVICE_PROVIDER_BIO`

Retrieves key data points about a specific service provider.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Service provider PitchBook ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Service Provider Profile Updates

**Slug:** `PITCHBOOK_GET_SERVICE_PROVIDER_UPDATES`

Retrieves changes for a service provider for up to the last 90 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since_date` | string | No | Updates after (>), before (<), or between (^) YYYY-MM-DD dates. |
| `pitchbook_id` | string | Yes | Service provider PitchBook ID. |
| `trailing_range` | integer | No | Updates from the last N days, up to 90. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Company Similar Companies

**Slug:** `PITCHBOOK_GET_SIMILAR_COMPANIES`

Retrieves top 10 similar companies/competitors

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pitchbook_id` | string | Yes | Company pbId |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Company Valuation Estimates

**Slug:** `PITCHBOOK_GET_VALUATION_ESTIMATES`

For a given pbId, returns valuation estimates based on PitchBook's predictive modeling. For detailed methodology explanation, please reference this document

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since_date` | string | No | Search for valuation estimates relating to the period after a specific date using the > operator, before a certain date using the < operator, and between 2 dates using the ^ operator. Format: YYYY-MM-DD. Use this parameter only when the historicalEstimates parameter is applied. |
| `pitchbook_id` | string | Yes | Company pbId |
| `prediction_drivers` | boolean | No | Include prediction driver fields in the response. To use this parameter, set it to True. False by default |
| `historical_estimates` | boolean | No | Include historical estimates. To use this parameter, set it to True. False by default |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Companies

**Slug:** `PITCHBOOK_SEARCH_COMPANIES`

Search PitchBook companies using the documented company, location, industry, financing, exit, financial, and patent filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | No | Filter companies by city. |
| `page` | string | No | Provider page number for the initial request. |
| `cursor` | string | No | Continuation cursor returned by the previous call; omit for the first page. |
| `country` | string | No | Filter companies by country code. |
| `revenue` | string | No | Revenue filter in millions. Prefix with > or <, or join two amounts with ^ for a range. |
| `currency` | string | No | Currency code for monetary filters such as deal_size; defaults according to the user's PitchBook preferences. |
| `industry` | string | No | Industry code. Only one industry classification can be used at a time. |
| `keywords` | string | No | Keywords associated with companies or appearing in their descriptions. Multiple keywords use OR logic and cannot be combined with another industry classification. |
| `per_page` | string | No | Number of results to return on the page, up to 250. |
| `deal_date` | string | No | Deal-date filter in YYYY-MM-DD form. Prefix with > or <, or join two dates with ^ for a range. |
| `deal_size` | string | No | Deal-size filter in millions. Prefix with > or <, or join two amounts with ^ for a range. |
| `deal_type` | string | No | Filter companies that have a specific deal type code. |
| `exit_date` | string | No | Investor exit-date filter in YYYY-MM-DD form. Prefix with > or <, or join two dates with ^ for a range. |
| `exit_size` | string | No | Investor exit-size filter in millions. Prefix with > or <, or join two amounts with ^ for a range. |
| `exit_type` | string | No | Filter companies by investor exit type code. |
| `full_exit` | string | No | Set to TRUE to find companies with a deal involving a full investor exit. |
| `post_code` | string | No | Filter companies by US or international postal code. |
| `verticals` | string | No | Vertical code. Only one industry classification can be used at a time. |
| `deal_status` | string | No | Filter by deal status code, such as failed, upcoming, or completed. |
| `exit_status` | string | No | Filter by exit status code, such as failed, upcoming, or completed. |
| `gecs_sector` | string | No | GECS sector code. Only one industry classification can be used at a time. |
| `date_founded` | string | No | Founding-date filter in YYYY-MM-DD form. Prefix with > or <, or join two dates with ^ for a range. |
| `partial_exit` | string | No | Set to TRUE to find companies with a deal involving a partial investor exit. |
| `total_raised` | string | No | Total-raised filter in millions. Prefix with > or <, or join two amounts with ^ for a range. |
| `company_names` | string | No | Accepts company names, PitchBook IDs, websites, and tickers. Use commas to separate multiple exact-match values. |
| `gecs_industry` | string | No | GECS industry code. Only one industry classification can be used at a time. |
| `location_type` | string | No | Location match mode: HQ_ONLY, NON_HQ_ONLY, or ANY. Use with city, state_province, country, or post_code. |
| `backing_status` | string | No | Filter companies by backing status code. |
| `employee_count` | string | No | Current employee-count filter. Prefix with > or <, or join two counts with ^ for a range. |
| `investor_names` | string | No | Investor names, PitchBook IDs, websites, or tickers. Use commas to separate multiple exact-match values. |
| `state_province` | string | No | Filter companies by state or province code. |
| `business_status` | string | No | Filter companies by business status code. |
| `emerging_spaces` | string | No | PitchBook emerging-space code. Only one industry classification can be used at a time. |
| `ownership_status` | string | No | Filter companies by ownership status code. |
| `gecs_industry_group` | string | No | GECS industry group code. Only one industry classification can be used at a time. |
| `industry_and_vertical` | string | No | Set to TRUE to use AND instead of OR across industry, verticals, and emerging_spaces filters. |
| `total_patent_families` | string | No | Patent-family count filter. Prefix with > or <, or join two counts with ^ for a range. |
| `patent_filing_location` | string | No | Patent filing-location code. Use commas to separate multiple values. |
| `total_patent_documents` | string | No | Total patent-document count filter. Prefix with > or <, or join two counts with ^ for a range. |
| `active_patent_documents` | string | No | Active patent-document count filter. Prefix with > or <, or join two counts with ^ for a range. |
| `pending_patent_documents` | string | No | Pending patent-document count filter. Prefix with > or <, or join two counts with ^ for a range. |
| `inactive_family_documents` | string | No | Inactive family-document count filter. Prefix with > or <, or join two counts with ^ for a range. |
| `patents_expiring_next_year` | string | No | Count filter for patents expiring next year. Prefix with > or <, or join two counts with ^ for a range. |
| `only_most_recent_transaction` | string | No | Set to TRUE to filter companies by their most recent deal only. |
| `exclude_deals_without_deal_size` | string | No | Set to TRUE to exclude companies whose deal size is unknown. Use only when deal_size is omitted. |
| `include_deals_without_deal_size` | string | No | Set to TRUE to include companies whose deal size is unknown. Use only with deal_size. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Credit News

**Slug:** `PITCHBOOK_SEARCH_CREDIT_NEWS`

Retrieve credit-news articles matching the specified criteria.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | string | No | Provider page number. |
| `cursor` | string | No | Cursor from a previous response; omit for the first page. |
| `issuer` | string | No | Issuer names, IDs, websites, or tickers. |
| `lender` | string | No | Lender names, IDs, websites, or tickers. |
| `topics` | string | No | Article topics, comma separated. |
| `authors` | string | No | Authors, comma separated. |
| `regions` | string | No | Covered regions, comma separated. |
| `sponsor` | string | No | Sponsor names, IDs, websites, or tickers. |
| `per_page` | string | No | Results per page, from 1 to 250. |
| `since_date` | string | No | Publication-date expression using >, <, or ^. |
| `asset_classes` | string | No | Covered asset classes, comma separated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Credit Research

**Slug:** `PITCHBOOK_SEARCH_CREDIT_RESEARCH`

Retrieve credit-research reports matching the specified criteria.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | string | No | Provider page number. |
| `cursor` | string | No | Cursor from a previous response; omit for the first page. |
| `authors` | string | No | Report authors. |
| `regions` | string | No | Covered regions. |
| `per_page` | string | No | Results per provider page. |
| `purposes` | string | No | Report purposes. |
| `file_types` | string | No | Available report file types. |
| `since_date` | string | No | Publication-date filter expression. |
| `market_types` | string | No | Covered market types. |
| `report_types` | string | No | Credit-research report types. |
| `asset_classes` | string | No | Covered asset classes. |
| `company_names` | string | No | Company names covered by the reports. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Deals

**Slug:** `PITCHBOOK_SEARCH_DEALS`

Search PitchBook deals and their associated companies using documented company, deal, exit, valuation, and location filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | No | City location of the companies involved in the deals. |
| `page` | string | No | Provider page number. Ignored when cursor is supplied. |
| `cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |
| `country` | string | No | Country code of the companies involved in the deals. |
| `revenue` | string | No | Company revenue in millions. Prefix with > or <, or separate a range with ^. |
| `currency` | string | No | Currency code for monetary filters such as deal_size; defaults to the connected user's preference. |
| `industry` | string | No | Industry code of the companies involved. Only one industry classification can be used at a time. |
| `keywords` | string | No | Keywords associated with the companies or appearing in their descriptions. Do not combine with another industry classification. |
| `per_page` | string | No | Number of results to return per page, up to 250. |
| `deal_date` | string | No | Deal-date filter in YYYY-MM-DD format. Prefix with > or <, or separate a range with ^. |
| `deal_size` | string | No | Deal size in millions. Prefix with > or <, or separate a range with ^. |
| `deal_type` | string | No | Deal type code. |
| `exit_date` | string | No | Exit-date filter in YYYY-MM-DD format. Prefix with > or <, or separate a range with ^. |
| `exit_size` | string | No | Exit size in millions. Prefix with > or <, or separate a range with ^. |
| `exit_type` | string | No | Exit type code. |
| `full_exit` | string | No | Set to TRUE to find deals containing a full investor exit. |
| `post_code` | string | No | US or foreign postal code of the companies involved in the deals. |
| `verticals` | string | No | Vertical code of the companies involved. Only one industry classification can be used at a time. |
| `deal_status` | string | No | Deal status code used to distinguish announced, completed, failed, upcoming, and other deals. |
| `exit_status` | string | No | Exit status code used to distinguish announced, completed, failed, upcoming, and other exits. |
| `gecs_sector` | string | No | GECS sector code of the companies involved. Do not combine GECS with another industry classification. |
| `date_founded` | string | No | Company founding-date filter in YYYY-MM-DD format. Prefix with > or <, or separate a range with ^. |
| `partial_exit` | string | No | Set to TRUE to find deals containing a partial investor exit. |
| `total_raised` | string | No | Total capital raised by the companies, in millions. Prefix with > or <, or separate a range with ^. |
| `company_names` | string | No | Accepts company names, pbIds, websites, and tickers to find deals for exact-matching companies. Separate multiple values with commas. |
| `gecs_industry` | string | No | GECS industry code of the companies involved. Do not combine GECS with another industry classification. |
| `location_type` | string | No | Company location type: HQ_ONLY, NON_HQ_ONLY, or ANY. Use with city, state_province, country, or post_code. |
| `backing_status` | string | No | Backing status code of the companies involved in the deals. |
| `investor_names` | string | No | Exact investor names, pbIds, websites, or tickers. Separate multiple values with commas. |
| `post_valuation` | string | No | Valuation at or after investment, in millions. Prefix with > or <, or separate a range with ^. |
| `state_province` | string | No | State or province code of the companies involved in the deals. |
| `business_status` | string | No | Business status code of the companies involved in the deals. |
| `ownership_status` | string | No | Ownership status code of the companies involved in the deals. |
| `gecs_industry_group` | string | No | GECS industry-group code of the companies involved. Do not combine GECS with another industry classification. |
| `pre_money_valuation` | string | No | Pre-money valuation in millions. Prefix with > or <, or separate a range with ^. |
| `industry_and_vertical` | string | No | Set to TRUE to apply AND logic when both industry and verticals are supplied; otherwise OR logic is used. |
| `only_most_recent_transaction` | string | No | Set to TRUE to return only each company's most recent deal. |
| `exclude_deals_without_deal_size` | string | No | Set to TRUE without deal_size to exclude deals whose size is unknown. Defaults to false upstream. |
| `include_deals_without_deal_size` | string | No | Set to TRUE with deal_size to include deals whose size is unknown. Defaults to false upstream. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Entities

**Slug:** `PITCHBOOK_SEARCH_ENTITIES`

Search across PitchBook business entities by ID, name, website, ticker, or exchange-qualified ticker.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | string | No | One-based provider page number to return. |
| `query` | string | No | Entity ID, name, website, ticker, or exchange-qualified ticker. Names support exact and partial matches; websites and tickers require exact matches. |
| `per_page` | string | No | Number of results to return on the provider page, up to 250. |
| `next_cursor` | string | No | Opaque cursor from a previous response; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Funds

**Slug:** `PITCHBOOK_SEARCH_FUNDS`

Search PitchBook funds and associated investors using the documented fund, commitment, performance, preference, and location filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dpi` | string | No | DPI multiple. Prefix with > or <, or separate a range with ^. |
| `irr` | string | No | IRR percentage. Prefix with > or <, or separate a range with ^. |
| `city` | string | No | City of the fund's investors. |
| `page` | string | No | Provider page number for the initial request. |
| `rvpi` | string | No | RVPI multiple. Prefix with > or <, or separate a range with ^. |
| `tvpi` | string | No | TVPI multiple. Prefix with > or <, or separate a range with ^. |
| `cursor` | string | No | Continuation cursor returned by the previous call; omit for the first page. |
| `country` | string | No | Country code of the fund's investors. |
| `vintage` | string | No | Fund vintage-year filter. Prefix with > or <, or separate a range with ^. |
| `currency` | string | No | Currency code for monetary filters; defaults to the connected user's preference. |
| `per_page` | string | No | Number of results to return on the page, up to 250. |
| `fund_date` | string | No | Fund-date filter in YYYY-MM-DD format. Prefix with > or <, or separate a range with ^. |
| `fund_size` | string | No | Fund size in millions. Prefix with > or <, or separate a range with ^. |
| `post_code` | string | No | Postal code of the fund's investors. |
| `dry_powder` | string | No | Dry powder in millions. Prefix with > or <, or separate a range with ^. |
| `fund_names` | string | No | Exact fund names or PitchBook IDs. Separate multiple values with commas. |
| `fund_status` | string | No | Fund status code. |
| `fund_strategy` | string | No | Fund strategy code. |
| `location_type` | string | No | Investor location type: HQ_ONLY, NON_HQ_ONLY, or ANY. Use with city, state_province, country, or post_code. |
| `investor_names` | string | No | Exact investor names, PitchBook IDs, websites, or tickers. Separate multiple values with commas. |
| `state_province` | string | No | State or province code of the fund's investors. |
| `commitment_date` | string | No | Individual commitment-date filter in YYYY-MM-DD format. Prefix with > or <, or separate a range with ^. |
| `commitment_size` | string | No | Individual commitment size in millions. Prefix with > or <, or separate a range with ^. |
| `industry_preferences` | string | No | Preferred industry code. |
| `preferred_deal_types` | string | No | Preferred deal type code. |
| `fund_domicile_country` | string | No | Country code where the fund is incorporated. |
| `limited_partner_names` | string | No | Exact limited partner names, PitchBook IDs, websites, or tickers. Separate multiple values with commas. |
| `verticals_preferences` | string | No | Preferred vertical code. |
| `additional_preferences` | string | No | Additional investment preference code. |
| `geographical_preferences` | string | No | Preferred state, area, province, territory, country, or region code. |
| `preferred_investment_amount` | string | No | Preferred investment amount in millions. Prefix with > or <, or separate a range with ^. |
| `fund_domicile_state_province` | string | No | State or province code where the fund is incorporated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Investors

**Slug:** `PITCHBOOK_SEARCH_INVESTORS`

Search PitchBook investors using the documented identity, fund, preference, investment, company, and location filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aum` | string | No | Assets-under-management filter in millions. Prefix with > or <, or join two amounts with ^ for a range. |
| `city` | string | No | Investor city. |
| `page` | string | No | Provider page number for the initial request. |
| `cursor` | string | No | Continuation cursor returned by the previous call; omit for the first page. |
| `country` | string | No | Investor country code. |
| `currency` | string | No | Currency code for monetary filters such as deal_size; defaults according to the user's PitchBook preferences. |
| `per_page` | string | No | Number of results to return on the page, up to 250. |
| `deal_city` | string | No | City of companies the investors have invested in. |
| `deal_date` | string | No | Past deal-date filter in YYYY-MM-DD form. Prefix with > or <, or join two dates with ^ for a range. |
| `deal_size` | string | No | Past deal-size filter in millions. Prefix with > or <, or join two amounts with ^ for a range. |
| `deal_type` | string | No | Past deal or investment type code. |
| `fund_date` | string | No | Underlying fund status-date filter in YYYY-MM-DD form. Prefix with > or <, or join two dates with ^ for a range. |
| `fund_size` | string | No | Underlying fund-size filter in millions. Prefix with > or <, or join two amounts with ^ for a range. |
| `post_code` | string | No | Investor US or international postal code. |
| `dry_powder` | string | No | Dry-powder filter in millions. Prefix with > or <, or join two amounts with ^ for a range. |
| `fund_names` | string | No | Underlying fund names or PitchBook IDs. Use commas to separate multiple exact-match values. |
| `deal_status` | string | No | Past deal or investment status code, such as announced, completed, failed, or upcoming. |
| `fund_status` | string | No | Underlying fund status code. |
| `deal_country` | string | No | Country code of companies the investors have invested in. |
| `company_names` | string | No | Companies the investors have invested in, specified by names, PitchBook IDs, websites, or tickers. Use commas for multiple exact-match values. |
| `deal_industry` | string | No | Industry code of companies the investors have invested in. |
| `deal_keywords` | string | No | Keywords associated with companies the investors have invested in. |
| `fund_strategy` | string | No | Underlying fund strategy code. |
| `investor_type` | string | No | Investor type code. |
| `location_type` | string | No | Location match mode: HQ_ONLY, NON_HQ_ONLY, or ANY. Use with city, state_province, country, or post_code. |
| `deal_post_code` | string | No | US or international postal code of companies the investors have invested in. |
| `deal_verticals` | string | No | Vertical code of companies the investors have invested in. |
| `investor_names` | string | No | Investor names, PitchBook IDs, websites, or tickers. Use commas to separate multiple exact-match values. |
| `state_province` | string | No | Investor state or province code. |
| `deal_location_type` | string | No | Company location match mode: HQ_ONLY, NON_HQ_ONLY, or ANY. Use with deal_city, deal_state_province, deal_country, or deal_post_code. |
| `deal_state_province` | string | No | State or province code of companies the investors have invested in. |
| `industry_preferences` | string | No | Preferred industry code. |
| `preferred_deal_types` | string | No | Preferred deal type code. |
| `limited_partner_names` | string | No | Limited partners invested in the investors' funds, specified by names, PitchBook IDs, websites, or tickers. Use commas for multiple exact-match values. |
| `verticals_preferences` | string | No | Preferred vertical code. |
| `additional_preferences` | string | No | Additional investment preference code. |
| `geographical_preferences` | string | No | Preferred state, area, province, territory, country, or region code. |
| `deal_industry_and_vertical` | string | No | Set to TRUE to apply AND instead of OR logic across deal_industry and deal_verticals. |
| `preferred_investment_amount` | string | No | Preferred investment-amount filter in millions. Prefix with > or <, or join two amounts with ^ for a range. |
| `only_most_recent_transaction` | string | No | Set to TRUE to filter using investors' most recent company transactions only. |
| `exclude_deals_without_deal_size` | string | No | Set to TRUE without deal_size to exclude investments whose deal size is unknown. |
| `include_deals_without_deal_size` | string | No | Set to TRUE with deal_size to include investments whose deal size is unknown. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Limited Partners

**Slug:** `PITCHBOOK_SEARCH_LIMITED_PARTNERS`

Retrieves limited partners matching the documented identity, commitment, mandate, and allocation criteria.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aum` | string | No | Assets-under-management filter in millions using >, <, or ^ range syntax. |
| `city` | string | No | Limited partner city. |
| `page` | string | No | Provider page number for the initial request. |
| `cursor` | string | No | Continuation cursor from the previous call; omit for the first page. |
| `country` | string | No | Limited partner country code. |
| `currency` | string | No | Currency code for monetary filters. |
| `per_page` | string | No | Number of results on the page, up to 250. |
| `post_code` | string | No | Limited partner US or international postal code. |
| `asset_types` | string | No | Asset allocation type code. |
| `fund_country` | string | No | Country code of committed funds. |
| `targeted_max` | string | No | Maximum target asset allocation in millions using >, <, or ^ range syntax. |
| `targeted_min` | string | No | Minimum target asset allocation in millions using >, <, or ^ range syntax. |
| `fund_strategy` | string | No | Strategy code of committed funds. |
| `location_type` | string | No | Location match mode: HQ_ONLY, NON_HQ_ONLY, or ANY. |
| `mandate_amount` | string | No | Mandate-amount filter in millions using >, <, or ^ range syntax. |
| `state_province` | string | No | Limited partner state or province code. |
| `commitment_date` | string | No | Commitment-date filter in YYYY-MM-DD form using >, <, or ^ range syntax. |
| `commitment_size` | string | No | Commitment-size filter in millions using >, <, or ^ range syntax. |
| `mandate_country` | string | No | Country code of mandates. |
| `mandate_end_date` | string | No | Mandate end-date filter in YYYY-MM-DD form using >, <, or ^ range syntax. |
| `mandate_keywords` | string | No | Keywords associated with mandates. |
| `fund_manager_focus` | string | No | Fund manager preference code for mandates. |
| `mandate_start_date` | string | No | Mandate start-date filter in YYYY-MM-DD form using >, <, or ^ range syntax. |
| `currently_allocated` | string | No | Current asset allocation amount filter in millions using >, <, or ^ range syntax. |
| `fund_state_province` | string | No | State or province code of committed funds. |
| `fund_strategy_focus` | string | No | Target fund strategy code for mandates. |
| `commitment_fund_size` | string | No | Committed fund size filter in millions using >, <, or ^ range syntax. |
| `limited_partner_type` | string | No | Limited partner type code. |
| `targeted_max_percent` | string | No | Maximum target asset allocation percentage using >, <, or ^ range syntax. |
| `targeted_min_percent` | string | No | Minimum target asset allocation percentage using >, <, or ^ range syntax. |
| `limited_partner_names` | string | No | Limited partner names, PitchBook IDs, websites, or tickers, comma-separated for multiple exact matches. |
| `mandate_status_former` | string | No | Set to TRUE to require former mandates. |
| `number_of_commitments` | string | No | Commitment-count filter using >, <, or ^ range syntax. |
| `mandate_state_province` | string | No | State or province code of mandates. |
| `mandate_status_current` | string | No | Set to TRUE to require current mandates. |
| `currently_allocated_percent` | string | No | Current asset allocation percentage filter using >, <, or ^ range syntax. |
| `commitment_fund_vintage_year` | string | No | Vintage-year filter for committed funds using >, <, or ^ range syntax. |
| `commitment_fund_industry_focus` | string | No | Industry code of committed funds. |
| `commitment_fund_country_preferences` | string | No | Preferred fund country code. |
| `commitment_fund_strategy_preferences` | string | No | Preferred fund strategy code. |
| `commitment_fund_state_province_preferences` | string | No | Preferred fund state or province code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Patents

**Slug:** `PITCHBOOK_SEARCH_PATENTS`

Retrieve patents for a company matching the specified criteria.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | string | No | Provider page number. |
| `cursor` | string | No | Cursor from a previous response; omit for the first page. |
| `status` | string | No | Patent statuses, comma separated. |
| `per_page` | string | No | Results per page, from 1 to 250. |
| `pitchbook_id` | string | Yes | PitchBook company ID. |
| `cpc_class_code` | string | No | CPC class codes, comma separated. |
| `cpc_section_code` | string | No | CPC section codes, comma separated. |
| `publication_date` | string | No | Publication-date expression using >, <, or ^. |
| `first_filing_date` | string | No | First-filing-date expression using >, <, or ^. |
| `filing_authority_location` | string | No | Filing-authority locations, comma separated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search People

**Slug:** `PITCHBOOK_SEARCH_PEOPLE`

Retrieves people along with their associated companies.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | No | City of associated entities. |
| `page` | string | No | Provider page number for the initial request. |
| `email` | string | No | Person email address. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `domain` | string | No | Person email domain. |
| `gender` | string | No | Gender, male or female. |
| `status` | string | No | Position status, active or former. |
| `country` | string | No | Country code of associated entities. |
| `industry` | string | No | Associated company industry code. |
| `per_page` | string | No | Results per page, up to 250. |
| `biography` | string | No | Words or phrases in biography text. |
| `firm_type` | string | No | Firm type code. |
| `last_name` | string | No | Person last name. |
| `post_code` | string | No | Postal code of associated entities. |
| `verticals` | string | No | Associated company vertical code. |
| `department` | string | No | Position department code. |
| `firm_names` | string | No | Firm names, PitchBook IDs, websites, or tickers, comma-separated. |
| `first_name` | string | No | Person first name. |
| `university` | string | No | Graduating institution. |
| `person_names` | string | No | Person names or PitchBook IDs, comma-separated. |
| `location_type` | string | No | Location match mode: HQ_ONLY, NON_HQ_ONLY, or ANY. |
| `position_level` | string | No | Position level code. |
| `position_title` | string | No | Keywords related to position titles. |
| `state_province` | string | No | State or province code of associated entities. |
| `industry_and_vertical` | string | No | Set to TRUE to apply AND logic to industry and vertical filters. |
| `primary_position_only` | string | No | Set to TRUE to match primary positions only. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Service Providers

**Slug:** `PITCHBOOK_SEARCH_SERVICE_PROVIDERS`

Retrieves service providers matching the specified criteria.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | No | Service provider city. |
| `page` | string | No | Provider page number for the initial request. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `country` | string | No | Service provider country code. |
| `currency` | string | No | Currency code for monetary filters. |
| `per_page` | string | No | Results per page, up to 250. |
| `deal_date` | string | No | Serviced deal-date filter using >, <, or ^ with YYYY-MM-DD. |
| `deal_size` | string | No | Serviced deal-size filter in millions using >, <, or ^. |
| `deal_type` | string | No | Serviced deal type code. |
| `post_code` | string | No | Service provider postal code. |
| `location_type` | string | No | Location match mode: HQ_ONLY, NON_HQ_ONLY, or ANY. |
| `state_province` | string | No | Service provider state or province code. |
| `company_country` | string | No | Country code of serviced companies. |
| `number_of_deals` | string | No | Serviced deal-count filter using >, <, or ^. |
| `company_industry` | string | No | Industry code of serviced companies. |
| `company_keywords` | string | No | Keywords of serviced companies. |
| `company_universe` | string | No | Serviced company universe code. |
| `company_verticals` | string | No | Vertical code of serviced companies. |
| `hired_for_deal_work` | string | No | Set to TRUE to require deal service work. |
| `company_location_type` | string | No | Serviced company location mode: HQ_ONLY, NON_HQ_ONLY, or ANY. |
| `hired_for_fundraising` | string | No | Set to TRUE to require fund service work. |
| `service_provider_type` | string | No | Service provider type code. |
| `service_types_on_deal` | string | No | Service type on deal code. |
| `company_state_province` | string | No | State or province code of serviced companies. |
| `service_provider_names` | string | No | Service provider names, PitchBook IDs, websites, or tickers, comma-separated. |
| `hired_for_general_services` | string | No | Set to TRUE to require general-service work. |
| `company_industry_and_vertical` | string | No | Set to TRUE to apply AND logic to company industry and vertical. |
| `exclude_deals_without_deal_size` | string | No | Set to TRUE without deal_size to exclude unknown deal sizes. |
| `include_deals_without_deal_size` | string | No | Set to TRUE with deal_size to include unknown deal sizes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Shared Search

**Slug:** `PITCHBOOK_SHARED_SEARCH`

Return entity names and PitchBook IDs from a PitchBook Shared Search.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hash` | string | No | Shared-search hash value. |
| `page` | string | No | One-based provider page number. |
| `per_page` | string | No | Number of results on the provider page. |
| `search_id` | string | Yes | Search ID from the generated PitchBook Shared Search URL. |
| `entity_type` | string ("COMPANIES" | "DEALS" | "INVESTORS" | "SERVICE_PROVIDERS" | "LIMITED_PARTNERS" | "PEOPLE" | "ENTITY_MANAGEMENT" | "FUNDS") | Yes | Type of entity returned by the shared search. |
| `next_cursor` | string | No | Cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
