> ## 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 Contracts History

> List the API contracts on your PitchBook account, active or past. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the API contracts on your PitchBook account, active or past.

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

## 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_contracts_history',
  {
    "activeContract": "example"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute pitchbook_get_contracts_history --input '{
  "activeContract": "example"
}' --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": [
    {
      "contractNumber": "example",
      "activeContract": true,
      "pricingModel": "example"
    }
  ]
}
```

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

## Input reference

Retrieves data for contracts within the account

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.activeContract` | `string` | No | — | Specify the type of contracts to be returned in a response. To get information only for the active contracts set this parameter as True, and only for the past contracts - as False. Do not set this parameter to receive data about all types of contracts |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieves data for contracts within the account",
    "properties": {
      "activeContract": {
        "type": "string",
        "description": "Specify the type of contracts to be returned in a response. To get information only for the active contracts set this parameter as True, and only for the past contracts - as False. Do not set this parameter to receive data about all types of contracts"
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `array` | Yes | — | Provider response payload. |
| `result.data[].contractNumber` | `string` | No | — | — |
| `result.data[].activeContract` | `boolean` | No | — | — |
| `result.data[].pricingModel` | `string` | No | — | — |
| `result.data[].startDate` | `string` | No | — | Format: `date`. |
| `result.data[].endDate` | `string \| null` | No | — | Format: `date`. |
| `result.data[].creditsChanged` | `integer` | No | — | Format: `int32`. |
| `result.data[].creditsExpired` | `integer` | No | — | Format: `int32`. |
| `result.data[].overageUsed` | `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": "array",
        "description": "Provider response payload.",
        "items": {
          "type": "object",
          "properties": {
            "contractNumber": {
              "type": "string"
            },
            "activeContract": {
              "type": "boolean"
            },
            "pricingModel": {
              "type": "string"
            },
            "startDate": {
              "type": "string",
              "format": "date"
            },
            "endDate": {
              "type": [
                "string",
                "null"
              ],
              "format": "date"
            },
            "creditsChanged": {
              "type": "integer",
              "format": "int32"
            },
            "creditsExpired": {
              "type": "integer",
              "format": "int32"
            },
            "overageUsed": {
              "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.