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

# PitchBook: Limited Partner Search

> Limited Partner Search. PitchBook Limited Partner Search reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.

Limited Partner Search.

<Info>
  Tool ID: `pitchbook_limited_partner_search`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'pitchbook_limited_partner_search',
  {
    "limitedPartnerNames": "example",
    "limitedPartnerType": "example",
    "city": "San Francisco"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={null}
deepline tools execute pitchbook_limited_partner_search --input '{
  "limitedPartnerNames": "example",
  "limitedPartnerType": "example",
  "city": "San Francisco"
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "stats": {
      "total": 123,
      "perPage": 123,
      "page": 123
    },
    "items": [
      {
        "limitedPartnerId": "limited_partner_123",
        "limitedPartnerName": "Example",
        "sandbox": true
      }
    ]
  }
}
```

Use `deepline tools get pitchbook_limited_partner_search --json` for the latest machine-readable contract.

## Input reference

Retrieves limited partners matching the specified criteria

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.limitedPartnerNames` | `string` | No | — | Accepts limited partner names, pbIds, websites, and tickers. Returns a list of limited partners that are an exact match. Use a comma to separate multiple values |
| `payload.limitedPartnerType` | `string` | No | — | Limited partners can be found by their limited partner type code |
| `payload.city` | `string` | No | — | Search for limited partners by their city location |
| `payload.stateProvince` | `string` | No | — | Search for limited partners by their state code or province code |
| `payload.country` | `string` | No | — | Search for limited partners by their country code |
| `payload.postCode` | `string` | No | — | Search for limited partners by their postcode, included to support searching for both US postal code and foreign |
| `payload.locationType` | `string` | No | — | Search for limited partners by additional parameter specifying HQ Only (HQ\_ONLY), Non-HQ Only (NON\_HQ\_ONLY) or any office location (ANY) values. Set this parameter in pair with city, stateProvince, country, postCode options |
| `payload.aum` | `string` | No | — | Search for limited partners by their amount of assets under management. Search for limited partners with AUM over a certain amount using the > operator, limited partners with AUM under a certain amount with the \< operator or limited partners within a range using the ^ operator. Amounts in millions |
| `payload.numberOfCommitments` | `string` | No | — | Search for limited partners by their count of commitments. Search for limited partners with commitments over a certain count using the > operator, limited partners with commitments under a certain count with the \< operator or limited partners within a range using the ^ operator. Counts in units |
| `payload.commitmentDate` | `string` | No | — | Search for limited partners by their commitments date. Search for limited partners with commitments after a certain date using the > operator, limited partners with commitments before a certain date using the \< operator or limited partners with commitments between 2 dates within a range using the ^ operator. Format: YYYY-MM-DD |
| `payload.commitmentSize` | `string` | No | — | Search for limited partners by their commitments of a certain size. Search for limited partners with commitments larger than an amount using the > operator, limited partners with commitments smaller than a certain amount using the \< operator or limited partners within a range using the ^ operator. Amounts in millions |
| `payload.fundStateProvince` | `string` | No | — | Search for limited partners by state code or province code of committed funds |
| `payload.fundCountry` | `string` | No | — | Search for limited partners by country code of committed funds |
| `payload.fundStrategy` | `string` | No | — | Search for limited partners by the fund strategy of committed funds. Pass a fund strategy code |
| `payload.mandateKeywords` | `string` | No | — | Search for limited partners by keywords they are associated with mandates |
| `payload.mandateStatusCurrent` | `string` | No | — | Search for limited partners that have current mandates. To use this parameter set it as True |
| `payload.mandateStatusFormer` | `string` | No | — | Search for limited partners that have former mandates. To use this parameter set it as True |
| `payload.mandateAmount` | `string` | No | — | Search for limited partners by their mandates of a certain size. Search for limited partners with mandates larger than an amount using the > operator, limited partners with mandates smaller than a certain amount using the \< operator or limited partners within a range using the ^ operator. Amounts in millions |
| `payload.mandateStartDate` | `string` | No | — | Search for limited partners by start date of mandates. Search for limited partners with mandates after a certain start date using the > operator, limited partners with mandates before a certain start date using the \< operator or limited partners with mandates between 2 start dates within a range using the ^ operator. Format: YYYY-MM-DD |
| `payload.mandateEndDate` | `string` | No | — | Search for limited partners by end date of mandates. Search for limited partners with mandates after a certain end date using the > operator, limited partners with mandates before a certain end date using the \< operator or limited partners with mandates between 2 end dates within a range using the ^ operator. Format: YYYY-MM-DD |
| `payload.mandateStateProvince` | `string` | No | — | Search for limited partners by state code or province code of mandates |
| `payload.mandateCountry` | `string` | No | — | Search for limited partners by country code of mandates |
| `payload.fundStrategyFocus` | `string` | No | — | Search for limited partners by the targeted fund strategy of committed mandates. Pass a fund strategy code |
| `payload.fundManagerFocus` | `string` | No | — | Search for limited partners by the manager preferences of committed mandates. Pass a fund manager focus code |
| `payload.assetTypes` | `string` | No | — | Search for limited partners by the allocation of assets. Pass an asset type code |
| `payload.currentlyAllocated` | `string` | No | — | Search for limited partners by the current specific assets of a certain size. Search for limited partners with current specific assets larger than an amount using the > operator, limited partners with current specific assets smaller than a certain amount using the \< operator or limited partners with current specific assets within a range using the ^ operator. Amounts in millions |
| `payload.currentlyAllocatedPercent` | `string` | No | — | Search for limited partners by the percent of current specific assets. Search for limited partners with the percent of current specific assets larger than a percent using the > operator, limited partners with the percent of current specific assets smaller than a percent using the \< operator or limited partners with the percent of current specific assets within a range using the ^ operator. Values in percents |
| `payload.targetedMin` | `string` | No | — | Search for limited partners by the minimum values of targeted specific assets of a certain size. Search for limited partners with the minimum values of targeted specific assets larger than an amount using the > operator, limited partners with the minimum values of targeted current specific assets smaller than a certain amount using the \< operator or limited partners with the minimum values of targeted current specific assets within a range using the ^ operator. Amounts in millions |
| `payload.targetedMax` | `string` | No | — | Search for limited partners by the maximum values of targeted specific assets of a certain size. Search for limited partners with the maximum values of targeted specific assets larger than an amount using the > operator, limited partners with the maximum values of targeted current specific assets smaller than a certain amount using the \< operator or limited partners with the maximum values of targeted current specific assets within a range using the ^ operator. Amounts in millions |
| `payload.targetedMinPercent` | `string` | No | — | Search for limited partners by the minimum percent of targeted specific assets. Search for limited partners with the the minimum percent of targeted specific assets larger than a percent using the > operator, limited partners with the minimum percent of targeted specific assets smaller than a percent using the \< operator or limited partners with the minimum percent of targeted specific assets within a range using the ^ operator. Values in percents |
| `payload.targetedMaxPercent` | `string` | No | — | Search for limited partners by the maximum percent of targeted specific assets. Search for limited partners with the the maximum percent of targeted specific assets larger than a percent using the > operator, limited partners with the maximum percent of targeted specific assets smaller than a percent using the \< operator or limited partners with the maximum percent of targeted specific assets within a range using the ^ operator. Values in percents |
| `payload.commitmentFundIndustryFocus` | `string` | No | — | Search for limited partners by the industry code of committed funds |
| `payload.commitmentFundVintageYear` | `string` | No | — | Search for limited partners by the vintage year of committed funds. Search for limited partners with fund's vintage year after a certain date using the > operator, limited partners with fund's vintage year before a certain date using the \< operator and limited partners with fund's vintage year between 2 dates using the ^ operator |
| `payload.commitmentFundSize` | `string` | No | — | Search for limited partners by the committed funds of a certain size. Search for limited partners with the committed funds larger than an amount using the > operator, limited partners with the committed funds smaller than a certain amount using the \< operator or limited partners with the committed funds within a range using the ^ operator. Amounts in millions |
| `payload.commitmentFundStrategyPreferences` | `string` | No | — | Search for limited partners by the fund strategy of preferred funds. Pass a fund strategy code |
| `payload.commitmentFundStateProvincePreferences` | `string` | No | — | Search for limited partners by state code or province code of preferred funds |
| `payload.commitmentFundCountryPreferences` | `string` | No | — | Search for limited partners by country code of preferred funds |
| `payload.currency` | `string` | No | — | — |
| `payload.page` | `string` | No | — | Results are returned so that they can be paged through. Set this parameter to increment the page |
| `payload.perPage` | `string` | No | — | How many returned results show on page |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Retrieves limited partners matching the specified criteria",
    "properties": {
      "limitedPartnerNames": {
        "type": "string",
        "description": "Accepts limited partner names, pbIds, websites, and tickers. Returns a list of limited partners that are an exact match. Use a comma to separate multiple values"
      },
      "limitedPartnerType": {
        "type": "string",
        "description": "Limited partners can be found by their limited partner type code"
      },
      "city": {
        "type": "string",
        "description": "Search for limited partners by their city location"
      },
      "stateProvince": {
        "type": "string",
        "description": "Search for limited partners by their state code or province code"
      },
      "country": {
        "type": "string",
        "description": "Search for limited partners by their country code"
      },
      "postCode": {
        "type": "string",
        "description": "Search for limited partners by their postcode, included to support searching for both US postal code and foreign"
      },
      "locationType": {
        "type": "string",
        "description": "Search for limited partners by additional parameter specifying HQ Only (HQ_ONLY), Non-HQ Only (NON_HQ_ONLY) or any office location (ANY) values. Set this parameter in pair with city, stateProvince, country, postCode options"
      },
      "aum": {
        "type": "string",
        "description": "Search for limited partners by their amount of assets under management. Search for limited partners with AUM over a certain amount using the > operator, limited partners with AUM under a certain amount with the < operator or limited partners within a range using the ^ operator. Amounts in millions"
      },
      "numberOfCommitments": {
        "type": "string",
        "description": "Search for limited partners by their count of commitments. Search for limited partners with commitments over a certain count using the > operator, limited partners with commitments under a certain count with the < operator or limited partners within a range using the ^ operator. Counts in units"
      },
      "commitmentDate": {
        "type": "string",
        "description": "Search for limited partners by their commitments date. Search for limited partners with commitments after a certain date using the > operator, limited partners with commitments before a certain date using the < operator or limited partners with commitments between 2 dates within a range using the ^ operator. Format: YYYY-MM-DD"
      },
      "commitmentSize": {
        "type": "string",
        "description": "Search for limited partners by their commitments of a certain size. Search for limited partners with commitments larger than an amount using the > operator, limited partners with commitments smaller than a certain amount using the < operator or limited partners within a range using the ^ operator. Amounts in millions"
      },
      "fundStateProvince": {
        "type": "string",
        "description": "Search for limited partners by state code or province code of committed funds"
      },
      "fundCountry": {
        "type": "string",
        "description": "Search for limited partners by country code of committed funds"
      },
      "fundStrategy": {
        "type": "string",
        "description": "Search for limited partners by the fund strategy of committed funds. Pass a fund strategy code"
      },
      "mandateKeywords": {
        "type": "string",
        "description": "Search for limited partners by keywords they are associated with mandates"
      },
      "mandateStatusCurrent": {
        "type": "string",
        "description": "Search for limited partners that have current mandates. To use this parameter set it as True"
      },
      "mandateStatusFormer": {
        "type": "string",
        "description": "Search for limited partners that have former mandates. To use this parameter set it as True"
      },
      "mandateAmount": {
        "type": "string",
        "description": "Search for limited partners by their mandates of a certain size. Search for limited partners with mandates larger than an amount using the > operator, limited partners with mandates smaller than a certain amount using the < operator or limited partners within a range using the ^ operator. Amounts in millions"
      },
      "mandateStartDate": {
        "type": "string",
        "description": "Search for limited partners by start date of mandates. Search for limited partners with mandates after a certain start date using the > operator, limited partners with mandates before a certain start date using the < operator or limited partners with mandates between 2 start dates within a range using the ^ operator. Format: YYYY-MM-DD"
      },
      "mandateEndDate": {
        "type": "string",
        "description": "Search for limited partners by end date of mandates. Search for limited partners with mandates after a certain end date using the > operator, limited partners with mandates before a certain end date using the < operator or limited partners with mandates between 2 end dates within a range using the ^ operator. Format: YYYY-MM-DD"
      },
      "mandateStateProvince": {
        "type": "string",
        "description": "Search for limited partners by state code or province code of mandates"
      },
      "mandateCountry": {
        "type": "string",
        "description": "Search for limited partners by country code of mandates"
      },
      "fundStrategyFocus": {
        "type": "string",
        "description": "Search for limited partners by the targeted fund strategy of committed mandates. Pass a fund strategy code"
      },
      "fundManagerFocus": {
        "type": "string",
        "description": "Search for limited partners by the manager preferences of committed mandates. Pass a fund manager focus code"
      },
      "assetTypes": {
        "type": "string",
        "description": "Search for limited partners by the allocation of assets. Pass an asset type code"
      },
      "currentlyAllocated": {
        "type": "string",
        "description": "Search for limited partners by the current specific assets of a certain size. Search for limited partners with current specific assets larger than an amount using the > operator, limited partners with current specific assets smaller than a certain amount using the < operator or limited partners with current specific assets within a range using the ^ operator. Amounts in millions"
      },
      "currentlyAllocatedPercent": {
        "type": "string",
        "description": "Search for limited partners by the percent of current specific assets. Search for limited partners with the percent of current specific assets larger than a percent using the > operator, limited partners with the percent of current specific assets smaller than a percent using the < operator or limited partners with the percent of current specific assets within a range using the ^ operator. Values in percents"
      },
      "targetedMin": {
        "type": "string",
        "description": "Search for limited partners by the minimum values of targeted specific assets of a certain size. Search for limited partners with the minimum values of targeted specific assets larger than an amount using the > operator, limited partners with the minimum values of targeted current specific assets smaller than a certain amount using the < operator or limited partners with the minimum values of targeted current specific assets within a range using the ^ operator. Amounts in millions"
      },
      "targetedMax": {
        "type": "string",
        "description": "Search for limited partners by the maximum values of targeted specific assets of a certain size. Search for limited partners with the maximum values of targeted specific assets larger than an amount using the > operator, limited partners with the maximum values of targeted current specific assets smaller than a certain amount using the < operator or limited partners with the maximum values of targeted current specific assets within a range using the ^ operator. Amounts in millions"
      },
      "targetedMinPercent": {
        "type": "string",
        "description": "Search for limited partners by the minimum percent of targeted specific assets. Search for limited partners with the the minimum percent of targeted specific assets larger than a percent using the > operator, limited partners with the minimum percent of targeted specific assets smaller than a percent using the < operator or limited partners with the minimum percent of targeted specific assets within a range using the ^ operator. Values in percents"
      },
      "targetedMaxPercent": {
        "type": "string",
        "description": "Search for limited partners by the maximum percent of targeted specific assets. Search for limited partners with the the maximum percent of targeted specific assets larger than a percent using the > operator, limited partners with the maximum percent of targeted specific assets smaller than a percent using the < operator or limited partners with the maximum percent of targeted specific assets within a range using the ^ operator. Values in percents"
      },
      "commitmentFundIndustryFocus": {
        "type": "string",
        "description": "Search for limited partners by the industry code of committed funds"
      },
      "commitmentFundVintageYear": {
        "type": "string",
        "description": "Search for limited partners by the vintage year of committed funds. Search for limited partners with fund's vintage year after a certain date using the > operator, limited partners with fund's vintage year before a certain date using the < operator and limited partners with fund's vintage year between 2 dates using the ^ operator"
      },
      "commitmentFundSize": {
        "type": "string",
        "description": "Search for limited partners by the committed funds of a certain size. Search for limited partners with the committed funds larger than an amount using the > operator, limited partners with the committed funds smaller than a certain amount using the < operator or limited partners with the committed funds within a range using the ^ operator. Amounts in millions"
      },
      "commitmentFundStrategyPreferences": {
        "type": "string",
        "description": "Search for limited partners by the fund strategy of preferred funds. Pass a fund strategy code"
      },
      "commitmentFundStateProvincePreferences": {
        "type": "string",
        "description": "Search for limited partners by state code or province code of preferred funds"
      },
      "commitmentFundCountryPreferences": {
        "type": "string",
        "description": "Search for limited partners by country code of preferred funds"
      },
      "currency": {
        "type": "string"
      },
      "page": {
        "type": "string",
        "description": "Results are returned so that they can be paged through. Set this parameter to increment the page"
      },
      "perPage": {
        "type": "string",
        "description": "How many returned results show on page"
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.stats` | `object` | No | — | — |
| `result.data.stats.total` | `integer` | No | — | Format: `int32`. |
| `result.data.stats.perPage` | `integer` | No | — | Format: `int32`. |
| `result.data.stats.page` | `integer` | No | — | Format: `int32`. |
| `result.data.stats.lastPage` | `integer` | No | — | Format: `int32`. |
| `result.data.items` | `array` | No | — | — |
| `result.data.items[].limitedPartnerId` | `string` | No | — | — |
| `result.data.items[].limitedPartnerName` | `string` | No | — | — |
| `result.data.items[].sandbox` | `boolean` | No | — | — |
| `result.data.items[].website` | `string \| null` | No | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "stats": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "perPage": {
                "type": "integer",
                "format": "int32"
              },
              "page": {
                "type": "integer",
                "format": "int32"
              },
              "lastPage": {
                "type": "integer",
                "format": "int32"
              }
            },
            "additionalProperties": false
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "limitedPartnerId": {
                  "type": "string"
                },
                "limitedPartnerName": {
                  "type": "string"
                },
                "sandbox": {
                  "type": "boolean"
                },
                "website": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [PitchBook provider guide](/docs/providers/pitchbook/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)


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