> ## 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: Get Entity Locations

> List an entity's headquarters and other office locations by its ID. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

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

> [!NOTE]
>
> 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.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "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 |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieves data about locations of HQ and alternate offices of the specific entity",
    "properties": {
      "pbId": {
        "type": "string",
        "description": "Entity pbId"
      }
    },
    "required": [
      "pbId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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). |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "entityId": {
            "type": "string"
          },
          "hqOffice": {
            "type": "object",
            "properties": {
              "location": {
                "type": "string"
              },
              "addressLine1": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "addressLine2": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "city": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "stateProvince": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "postCode": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "country": {
                "type": "string"
              },
              "phone": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "fax": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "email": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "globalRegion": {
                "type": "string"
              },
              "globalSubRegion": {
                "type": "string"
              }
            },
            "additionalProperties": false
          },
          "alternateOffices": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "location": {
                  "type": "string"
                },
                "addressLine1": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "addressLine2": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "city": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "stateProvince": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "postCode": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "country": {
                  "type": "string"
                },
                "phone": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "fax": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "email": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "globalRegion": {
                  "type": "string"
                },
                "globalSubRegion": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          },
          "alternateOfficesCount": {
            "type": "integer",
            "format": "int32"
          }
        },
        "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](https://deepline.com/docs/providers/pitchbook/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


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