> ## 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 Sandbox Entities

> Sandbox Entities. PitchBook Get Sandbox Entities reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.

Sandbox Entities.

<Info>
  Tool ID: `pitchbook_get_sandbox_entities`
</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_get_sandbox_entities',
  {
    "entityType": "COMPANIES"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute pitchbook_get_sandbox_entities --input '{
  "entityType": "COMPANIES"
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "entityTypeCounts": {
      "companies": 123,
      "deals": 123,
      "investors": 123
    },
    "companies": [
      {
        "companyId": "company_123",
        "companyName": "Example Corp"
      }
    ],
    "investors": [
      {
        "investorId": "investor_123",
        "investorName": "Example"
      }
    ]
  }
}
```

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

## Input reference

Returns the list of entities available to test with a sandbox API key.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.entityType` | `"COMPANIES" \| "INVESTORS" \| "LIMITED_PARTNERS" \| "SERVICE_PROVIDERS" \| "PEOPLE" \| "DEALS" \| "FUNDS" \| "CREDIT_NEWS"` | No | — | Specify the type of entity to be returned from the Sandbox. If this parameter is not specified, all information from Sandbox will be returned in response Allowed: `COMPANIES`, `INVESTORS`, `LIMITED_PARTNERS`, `SERVICE_PROVIDERS`, `PEOPLE`, `DEALS`, `FUNDS`, `CREDIT_NEWS`. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Returns the list of entities available to test with a sandbox API key.",
    "properties": {
      "entityType": {
        "type": "string",
        "description": "Specify the type of entity to be returned from the Sandbox. If this parameter is not specified, all information from Sandbox will be returned in response",
        "enum": [
          "COMPANIES",
          "INVESTORS",
          "LIMITED_PARTNERS",
          "SERVICE_PROVIDERS",
          "PEOPLE",
          "DEALS",
          "FUNDS",
          "CREDIT_NEWS"
        ]
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.entityTypeCounts` | `object` | No | — | — |
| `result.data.entityTypeCounts.companies` | `integer` | No | — | Format: `int32`. |
| `result.data.entityTypeCounts.deals` | `integer` | No | — | Format: `int32`. |
| `result.data.entityTypeCounts.investors` | `integer` | No | — | Format: `int32`. |
| `result.data.entityTypeCounts.people` | `integer` | No | — | Format: `int32`. |
| `result.data.entityTypeCounts.funds` | `integer` | No | — | Format: `int32`. |
| `result.data.entityTypeCounts.limitedPartners` | `integer` | No | — | Format: `int32`. |
| `result.data.entityTypeCounts.serviceProviders` | `integer` | No | — | Format: `int32`. |
| `result.data.entityTypeCounts.creditNews` | `integer` | No | — | Format: `int32`. |
| `result.data.companies` | `array` | No | — | — |
| `result.data.companies[].companyId` | `string` | No | — | — |
| `result.data.companies[].companyName` | `string` | No | — | — |
| `result.data.investors` | `array` | No | — | — |
| `result.data.investors[].investorId` | `string` | No | — | — |
| `result.data.investors[].investorName` | `string` | No | — | — |
| `result.data.dealIds` | `array` | No | — | — |
| `result.data.dealIds[].dealId` | `string` | No | — | — |
| `result.data.people` | `array` | No | — | — |
| `result.data.people[].personId` | `string` | No | — | — |
| `result.data.people[].personName` | `string` | No | — | — |
| `result.data.funds` | `array` | No | — | — |
| `result.data.funds[].fundId` | `string` | No | — | — |
| `result.data.funds[].fundName` | `string` | No | — | — |
| `result.data.limitedPartners` | `array` | No | — | — |
| `result.data.limitedPartners[].limitedPartnerId` | `string` | No | — | — |
| `result.data.limitedPartners[].limitedPartnerName` | `string` | No | — | — |
| `result.data.serviceProviders` | `array` | No | — | — |
| `result.data.serviceProviders[].serviceProviderId` | `string` | No | — | — |
| `result.data.serviceProviders[].serviceProviderName` | `string` | No | — | — |
| `result.data.creditNews` | `array` | No | — | — |
| `result.data.creditNews[].articleId` | `integer` | No | — | Format: `int32`. |
| `result.data.creditNews[].articleTitle` | `string` | 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": {
          "entityTypeCounts": {
            "type": "object",
            "properties": {
              "companies": {
                "type": "integer",
                "format": "int32"
              },
              "deals": {
                "type": "integer",
                "format": "int32"
              },
              "investors": {
                "type": "integer",
                "format": "int32"
              },
              "people": {
                "type": "integer",
                "format": "int32"
              },
              "funds": {
                "type": "integer",
                "format": "int32"
              },
              "limitedPartners": {
                "type": "integer",
                "format": "int32"
              },
              "serviceProviders": {
                "type": "integer",
                "format": "int32"
              },
              "creditNews": {
                "type": "integer",
                "format": "int32"
              }
            },
            "additionalProperties": false
          },
          "companies": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "companyId": {
                  "type": "string"
                },
                "companyName": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          },
          "investors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "investorId": {
                  "type": "string"
                },
                "investorName": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          },
          "dealIds": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "dealId": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          },
          "people": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "personId": {
                  "type": "string"
                },
                "personName": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          },
          "funds": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "fundId": {
                  "type": "string"
                },
                "fundName": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          },
          "limitedPartners": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "limitedPartnerId": {
                  "type": "string"
                },
                "limitedPartnerName": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          },
          "serviceProviders": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "serviceProviderId": {
                  "type": "string"
                },
                "serviceProviderName": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          },
          "creditNews": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "articleId": {
                  "type": "integer",
                  "format": "int32"
                },
                "articleTitle": {
                  "type": "string"
                }
              },
              "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.