> ## 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 Deal Debt Lenders

> Get the debt and lenders in a deal by its ID. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get the debt and lenders in a deal by its ID.

> [!NOTE]
>
> Tool ID: `pitchbook_get_deal_debt_lenders`

## 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_deal_debt_lenders',
  {
    "pbId": "pb_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute pitchbook_get_deal_debt_lenders --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": {
    "dealId": "deal_123",
    "dealNumber": 123,
    "company": {
      "id": "id_123",
      "name": "Example"
    }
  }
}
```

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

## Input reference

Retrieves debt and lender data within the specific deal

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.pbId` | `string` | Yes | — | Deal pbId |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieves debt and lender data within the specific deal",
    "properties": {
      "pbId": {
        "type": "string",
        "description": "Deal 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.dealId` | `string` | No | — | — |
| `result.data.dealNumber` | `integer` | No | — | Format: `int32`. |
| `result.data.company` | `object \| null` | No | — | — |
| `result.data.company.id` | `string` | No | — | — |
| `result.data.company.name` | `string` | No | — | — |
| `result.data.debts` | `array` | No | — | — |
| `result.data.debts[].pbId` | `string` | No | — | — |
| `result.data.debts[].debtSize` | `object \| null` | No | — | — |
| `result.data.debts[].debtSize.amount` | `number` | No | — | — |
| `result.data.debts[].debtSize.currency` | `string` | No | — | — |
| `result.data.debts[].debtSize.nativeAmount` | `number` | No | — | — |
| `result.data.debts[].debtSize.nativeCurrency` | `string` | No | — | — |
| `result.data.debts[].debtSize.estimated` | `boolean` | No | — | — |
| `result.data.debts[].paymentInKind` | `number \| null` | No | — | Format: `double`. |
| `result.data.debts[].debtType` | `object \| null` | No | — | — |
| `result.data.debts[].debtType.code` | `string` | No | — | — |
| `result.data.debts[].debtType.description` | `string` | No | — | — |
| `result.data.debts[].seniority` | `object \| null` | No | — | — |
| `result.data.debts[].seniority.code` | `string` | No | — | — |
| `result.data.debts[].seniority.description` | `string` | No | — | — |
| `result.data.debts[].security` | `object \| null` | No | — | — |
| `result.data.debts[].security.code` | `string` | No | — | — |
| `result.data.debts[].security.description` | `string` | No | — | — |
| `result.data.debts[].subordination` | `object \| null` | No | — | — |
| `result.data.debts[].subordination.code` | `string` | No | — | — |
| `result.data.debts[].subordination.description` | `string` | No | — | — |
| `result.data.debts[].term` | `object \| null` | No | — | — |
| `result.data.debts[].term.code` | `string` | No | — | — |
| `result.data.debts[].term.description` | `string` | No | — | — |
| `result.data.debts[].floor` | `number \| null` | No | — | Format: `double`. |
| `result.data.debts[].ceiling` | `number \| null` | No | — | Format: `double`. |
| `result.data.debts[].breakDate` | `string \| null` | No | — | Format: `date`. |
| `result.data.debts[].breakPrice` | `number \| null` | No | — | Format: `double`. |
| `result.data.debts[].resetFrequency` | `string \| null` | No | — | — |
| `result.data.debts[].coupon` | `number \| null` | No | — | Format: `double`. |
| `result.data.debts[].additionalDebtCharacteristics` | `object` | No | — | — |
| `result.data.debts[].additionalDebtCharacteristics.unitranche` | `boolean \| null` | No | — | — |
| `result.data.debts[].additionalDebtCharacteristics.syndicated` | `boolean \| null` | No | — | — |
| `result.data.debts[].additionalDebtCharacteristics.mezzanine` | `boolean \| null` | No | — | — |
| `result.data.debts[].additionalDebtCharacteristics.covLite` | `boolean \| null` | No | — | — |
| `result.data.debts[].additionalDebtCharacteristics.warrants` | `boolean \| null` | No | — | — |
| `result.data.debts[].additionalDebtCharacteristics.convertible` | `boolean` | No | — | — |
| `result.data.debts[].additionalDebtCharacteristics.rate` | `object \| null` | No | — | — |
| `result.data.debts[].additionalDebtCharacteristics.rate.code` | `string` | No | — | — |
| `result.data.debts[].additionalDebtCharacteristics.rate.description` | `string` | No | — | — |
| `result.data.debts[].maturityDate` | `string \| null` | No | — | Format: `date`. |
| `result.data.debts[].spreadInterestRate` | `number \| null` | No | — | Format: `double`. |
| `result.data.debts[].tradeDate` | `string \| null` | No | — | Format: `date`. |
| `result.data.debts[].tenorYears` | `number \| null` | No | — | Format: `double`. |

The table shows the first 50 fields. Expand the raw schema below for every field.

> [!NOTE]
>
> This output schema is too large for an inline display. Read the complete live contract with `deepline describe pitchbook_get_deal_debt_lenders --json`.

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