Fundamentals

Sandbox Entities

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

get/sandbox-entities

Request

  • Base URL
    https://api.pitchbook.com
  • URL
    https://api.pitchbook.com/sandbox-entities
  • Auth
    API key in header Authorization

Query parameters

entityType'COMPANIES' | 'INVESTORS' | 'LIMITED_PARTNERS' | 'SERVICE_PROVIDERS' | 'PEOPLE' | 'DEALS' | 'FUNDS' | 'CREDIT_NEWS'

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

Response

OK

Example response

{
  "entityTypeCounts": {
    "companies": 1,
    "deals": 1,
    "investors": 1,
    "people": 1,
    "funds": 1,
    "limitedPartners": 1,
    "serviceProviders": 1,
    "creditNews": 1
  },
  "companies": [
    {
      "companyId": "11009-35",
      "companyName": "Raymond Loewy International"
    }
  ],
  "investors": [
    {
      "investorId": "11193-94",
      "investorName": "Franklin Street Equity Partners"
    }
  ],
  "dealIds": [
    {
      "dealId": "118074-52T"
    }
  ],
  "people": [
    {
      "personId": "195066-01P",
      "personName": "John Taylor"
    }
  ],
  "funds": [
    {
      "fundId": "22091-59F",
      "fundName": "Wework Property Investors Operating Partnership III"
    }
  ],
  "limitedPartners": [
    {
      "limitedPartnerId": "11603-71",
      "limitedPartnerName": "an Francisco Employees' Retirement System"
    }
  ],
  "serviceProviders": [
    {
      "serviceProviderId": "10015-03",
      "serviceProviderName": "EY"
    }
  ],
  "creditNews": [
    {
      "articleId": 118074,
      "articleTitle": "WeWork Property Investors Operating Partnership III Announces $1.5 Billion Credit Facility"
    }
  ]
}

Changes

No recorded changes to this operation across all 9 revisions of this API.