latestOpenAPI 3.0.12026-08-17127235413.6 KB

eab6a2753503

General

Shared Search

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.<br/><br/> For example, the following is the generated link for a Shared Search for US PE-Backed Companies: <br/>https://content.pitchbook.com/share/quick-link/search/8e6bd17e-dea5-4eca-8143-dddb2ab623a0?hash=484124ea029982f76ec42f9a53cb3452f2d75eb013d75478a547d542b852e1c7 <br/> 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

get/{entityType}/search

Path parameters

entityType'COMPANIES' | 'DEALS' | 'INVESTORS' | 'SERVICE_PROVIDERS' | 'LIMITED_PARTNERS' | 'PEOPLE' | 'ENTITY_MANAGEMENT' | 'FUNDS' required

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

Query parameters

searchIdstring required

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

hashstring

Hash value for shared search

pagestring

Results are returned so that they can be paged through. Set this parameter to increment the page

perPagestring

How many returned results show on page

Response

OK