PitchBook: Get Entity Locations

List an entity’s headquarters and other office locations by its ID.

Tool ID: pitchbook_get_entity_locations

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'pitchbook_get_entity_locations',
  {
    "pbId": "pb_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute pitchbook_get_entity_locations --input '{
  "pbId": "pb_123"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "entityId": "entity_123",
    "hqOffice": {
      "location": "example",
      "addressLine1": "example",
      "addressLine2": "example"
    },
    "alternateOffices": [
      {
        "location": "example",
        "addressLine1": "example",
        "addressLine2": "example"
      }
    ]
  }
}

Use deepline describe pitchbook_get_entity_locations --json for the latest machine-readable contract.

Input reference

Retrieves data about locations of HQ and alternate offices of the specific entity

Name	Type	Required	Default	Details
`payload.pbId`	`string`	Yes	—	Entity pbId

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.entityId`	`string`	No	—	—
`result.data.hqOffice`	`object`	No	—	—
`result.data.hqOffice.location`	`string`	No	—	—
`result.data.hqOffice.addressLine1`	`string \| null`	No	—	—
`result.data.hqOffice.addressLine2`	`string \| null`	No	—	—
`result.data.hqOffice.city`	`string \| null`	No	—	—
`result.data.hqOffice.stateProvince`	`string \| null`	No	—	—
`result.data.hqOffice.postCode`	`string \| null`	No	—	—
`result.data.hqOffice.country`	`string`	No	—	—
`result.data.hqOffice.phone`	`string \| null`	No	—	—
`result.data.hqOffice.fax`	`string \| null`	No	—	—
`result.data.hqOffice.email`	`string \| null`	No	—	—
`result.data.hqOffice.globalRegion`	`string`	No	—	—
`result.data.hqOffice.globalSubRegion`	`string`	No	—	—
`result.data.alternateOffices`	`array`	No	—	—
`result.data.alternateOffices[].location`	`string`	No	—	—
`result.data.alternateOffices[].addressLine1`	`string \| null`	No	—	—
`result.data.alternateOffices[].addressLine2`	`string \| null`	No	—	—
`result.data.alternateOffices[].city`	`string \| null`	No	—	—
`result.data.alternateOffices[].stateProvince`	`string \| null`	No	—	—
`result.data.alternateOffices[].postCode`	`string \| null`	No	—	—
`result.data.alternateOffices[].country`	`string`	No	—	—
`result.data.alternateOffices[].phone`	`string \| null`	No	—	—
`result.data.alternateOffices[].fax`	`string \| null`	No	—	—
`result.data.alternateOffices[].email`	`string \| null`	No	—	—
`result.data.alternateOffices[].globalRegion`	`string`	No	—	—
`result.data.alternateOffices[].globalSubRegion`	`string`	No	—	—
`result.data.alternateOfficesCount`	`integer`	No	—	Format: `int32`.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

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

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation