> ## 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: People Search

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

People Search.

<Info>
  Tool ID: `pitchbook_people_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_people_search',
  {
    "firmNames": "example",
    "personNames": "example",
    "biography": "example"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute pitchbook_people_search --input '{
  "firmNames": "example",
  "personNames": "example",
  "biography": "example"
}' --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": [
      {
        "personId": "person_123",
        "personName": "Example",
        "firmId": "firm_123"
      }
    ]
  }
}
```

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

## Input reference

Retrieves people along with the companies associated with the person

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.firmNames` | `string` | No | — | Accepts firm names, pbIds, websites, and tickers. Returns a list of persons from all entities that are an exact match. Use a comma to separate multiple values |
| `payload.personNames` | `string` | No | — | Accepts person names, and pbIds. Returns a list of persons that are an exact match. Use a comma to separate multiple values |
| `payload.biography` | `string` | No | — | Search for people by words and phrases in their biography text |
| `payload.university` | `string` | No | — | Find people by their graduating institution |
| `payload.firmType` | `string` | No | — | Find people associated with a specific firm type code |
| `payload.positionLevel` | `string` | No | — | Find people by their position level code |
| `payload.positionTitle` | `string` | No | — | Find people by the keywords related to their positions |
| `payload.primaryPositionOnly` | `string` | No | — | Search for people by additional parameter concerning their positions. Set this parameter as True and use in pair with positionTitle option |
| `payload.department` | `string` | No | — | Find people within an organization by the department they work in. Pass a position department code |
| `payload.status` | `string` | No | — | Find people by position status (active or former) |
| `payload.gender` | `string` | No | — | Find people by gender (male or female) |
| `payload.industry` | `string` | No | — | People can be found by industry code of the companies associated with them |
| `payload.verticals` | `string` | No | — | People can be found by vertical code of the companies associated with them |
| `payload.industryAndVertical` | `string` | No | — | When using both industry and vertical parameters, "OR" logic is used by default. To use "AND" logic, set this parameter to True. Set this parameter in pair with industry and vertical options |
| `payload.city` | `string` | No | — | Search for people by city of their entities |
| `payload.stateProvince` | `string` | No | — | Search for people by state code or province code of their entities |
| `payload.country` | `string` | No | — | Search for people by country code of their entities |
| `payload.postCode` | `string` | No | — | Search for people by postcodes of their entities |
| `payload.locationType` | `string` | No | — | Search for people by additional parameter concerning the entities 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.firstName` | `string` | No | — | Find people by first name |
| `payload.lastName` | `string` | No | — | Find people by last name |
| `payload.email` | `string` | No | — | Find people by email |
| `payload.domain` | `string` | No | — | Find people by domain |
| `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 people along with the companies associated with the person",
    "properties": {
      "firmNames": {
        "type": "string",
        "description": "Accepts firm names, pbIds, websites, and tickers. Returns a list of persons from all entities that are an exact match. Use a comma to separate multiple values"
      },
      "personNames": {
        "type": "string",
        "description": "Accepts person names, and pbIds. Returns a list of persons that are an exact match. Use a comma to separate multiple values"
      },
      "biography": {
        "type": "string",
        "description": "Search for people by words and phrases in their biography text"
      },
      "university": {
        "type": "string",
        "description": "Find people by their graduating institution"
      },
      "firmType": {
        "type": "string",
        "description": "Find people associated with a specific firm type code"
      },
      "positionLevel": {
        "type": "string",
        "description": "Find people by their position level code"
      },
      "positionTitle": {
        "type": "string",
        "description": "Find people by the keywords related to their positions"
      },
      "primaryPositionOnly": {
        "type": "string",
        "description": "Search for people by additional parameter concerning their positions. Set this parameter as True and use in pair with positionTitle option"
      },
      "department": {
        "type": "string",
        "description": "Find people within an organization by the department they work in. Pass a position department code"
      },
      "status": {
        "type": "string",
        "description": "Find people by position status (active or former)"
      },
      "gender": {
        "type": "string",
        "description": "Find people by gender (male or female)"
      },
      "industry": {
        "type": "string",
        "description": "People can be found by industry code of the companies associated with them"
      },
      "verticals": {
        "type": "string",
        "description": "People can be found by vertical code of the companies associated with them"
      },
      "industryAndVertical": {
        "type": "string",
        "description": "When using both industry and vertical parameters, \"OR\" logic is used by default. To use \"AND\" logic, set this parameter to True. Set this parameter in pair with industry and vertical options"
      },
      "city": {
        "type": "string",
        "description": "Search for people by city of their entities"
      },
      "stateProvince": {
        "type": "string",
        "description": "Search for people by state code or province code of their entities"
      },
      "country": {
        "type": "string",
        "description": "Search for people by country code of their entities"
      },
      "postCode": {
        "type": "string",
        "description": "Search for people by postcodes of their entities"
      },
      "locationType": {
        "type": "string",
        "description": "Search for people by additional parameter concerning the entities 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"
      },
      "firstName": {
        "type": "string",
        "description": "Find people by first name"
      },
      "lastName": {
        "type": "string",
        "description": "Find people by last name"
      },
      "email": {
        "type": "string",
        "description": "Find people by email"
      },
      "domain": {
        "type": "string",
        "description": "Find people by domain"
      },
      "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[].personId` | `string` | No | — | — |
| `result.data.items[].personName` | `string` | No | — | — |
| `result.data.items[].firmId` | `string` | No | — | — |
| `result.data.items[].sandbox` | `boolean` | 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": {
                "personId": {
                  "type": "string"
                },
                "personName": {
                  "type": "string"
                },
                "firmId": {
                  "type": "string"
                },
                "sandbox": {
                  "type": "boolean"
                }
              },
              "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.