> ## 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: Shared Search > Shared Search. PitchBook Shared Search reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost. Shared Search. Tool ID: `pitchbook_shared_search` ## 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_shared_search', { "entityType": "COMPANIES", "searchId": "search_123" }, ); console.log(result.toolResponse.raw); ``` ### CLI ```bash theme={null} deepline tools execute pitchbook_shared_search --input '{ "entityType": "COMPANIES", "searchId": "search_123" }' --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 }, "searchCriteria": "software companies hiring engineers", "items": [ {} ] } } ``` Use `deepline tools get pitchbook_shared_search --json` for the latest machine-readable contract. ## Input reference Extracts the specified entity names and pbIds from an Advanced Search that has been shared from a PitchBook platform user. This endpoint supports the extraction of pbIds for Companies, Deals, Investors, Funds, Limited Partners, Service Providers, People and Entity Management. The Shared Search endpoint can be an easier way to get the names and pbIds for your universe instead of using another search endpoint, such as Company Search. To generate a Shared Search link, click the share icon located in the Advanced Search Results page or Saved Searches/Lists sections. For example, the following is the generated link for a Shared Search for US PE-Backed Companies: [https://content.pitchbook.com/share/quick-link/search/8e6bd17e-dea5-4eca-8143-dddb2ab623a0?hash=484124ea029982f76ec42f9a53cb3452f2d75eb013d75478a547d542b852e1c7](https://content.pitchbook.com/share/quick-link/search/8e6bd17e-dea5-4eca-8143-dddb2ab623a0?hash=484124ea029982f76ec42f9a53cb3452f2d75eb013d75478a547d542b852e1c7) In the example above, the search ID value is: See the live schema below for the complete notes. | Name | Type | Required | Default | Details | | - | - | - | - | - | | `payload.entityType` | `"COMPANIES" \| "DEALS" \| "INVESTORS" \| "SERVICE_PROVIDERS" \| "LIMITED_PARTNERS" \| "PEOPLE" \| "ENTITY_MANAGEMENT" \| "FUNDS"` | Yes | — | Specify the type of entity to be returned from the PitchBook Shared Search. The ENTITY\_MANAGEMENT entityType enables users to pull back people information from Companies & Deals, Investors & Funds, and Limited Partners searches. The People entityType is reserved for People screener shared searches Allowed: `COMPANIES`, `DEALS`, `INVESTORS`, `SERVICE_PROVIDERS`, `LIMITED_PARTNERS`, `PEOPLE`, `ENTITY_MANAGEMENT`, `FUNDS`. | | `payload.searchId` | `string` | Yes | — | Pass a search ID found in the generated URL of a PitchBook Shared Search. Note that this is different than copying the URL found in the browser | | `payload.hash` | `string` | No | — | Hash value for shared search | | `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 |
Show raw input schema ### Input JSON Schema ```json theme={null} { "type": "object", "description": "Extracts the specified entity names and pbIds from an Advanced Search that has been shared from a PitchBook platform user. This endpoint supports the extraction of pbIds for Companies, Deals, Investors, Funds, Limited Partners, Service Providers, People and Entity Management. The Shared Search endpoint can be an easier way to get the names and pbIds for your universe instead of using another search endpoint, such as Company Search. To generate a Shared Search link, click the share icon located in the Advanced Search Results page or Saved Searches/Lists sections. For example, the following is the generated link for a Shared Search for US PE-Backed Companies: https://content.pitchbook.com/share/quick-link/search/8e6bd17e-dea5-4eca-8143-dddb2ab623a0?hash=484124ea029982f76ec42f9a53cb3452f2d75eb013d75478a547d542b852e1c7 In the example above, the search ID value is: 8e6bd17e-dea5-4eca-8143-dddb2ab623a0, the hash value is 484124ea029982f76ec42f9a53cb3452f2d75eb013d75478a547d542b852e1c7 and the available entity types include: Companies, Deals, Investors and Entity_Management", "properties": { "entityType": { "type": "string", "description": "Specify the type of entity to be returned from the PitchBook Shared Search. The ENTITY_MANAGEMENT entityType enables users to pull back people information from Companies & Deals, Investors & Funds, and Limited Partners searches. The People entityType is reserved for People screener shared searches", "enum": [ "COMPANIES", "DEALS", "INVESTORS", "SERVICE_PROVIDERS", "LIMITED_PARTNERS", "PEOPLE", "ENTITY_MANAGEMENT", "FUNDS" ] }, "searchId": { "type": "string", "description": "Pass a search ID found in the generated URL of a PitchBook Shared Search. Note that this is different than copying the URL found in the browser" }, "hash": { "type": "string", "description": "Hash value for shared search" }, "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": [ "entityType", "searchId" ], "additionalProperties": false } ```
## 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.searchCriteria` | `string` | No | — | — | | `result.data.items` | `array` | No | — | — | | `result.meta` | `object` | No | — | Additional response metadata (status, paging). |
Show raw output schema ### 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 }, "searchCriteria": { "type": "string" }, "items": { "type": "array", "items": { "type": "object" } } }, "additionalProperties": false }, "meta": { "type": "object", "description": "Additional response metadata (status, paging).", "additionalProperties": true } }, "required": [ "data" ], "additionalProperties": false } ```
## 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.