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

# CB Insights: Cbinsights Post V2 Businessrelationships

> Get the partnerships, client, vendor and licensing relationships of several companies by their org IDs. Includes SDK V2 examples, schemas, and cost.

Get the partnerships, client, vendor and licensing relationships of several companies by their org IDs.

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

## 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(
  'cbinsights_post_v2_businessrelationships',
  {
    "orgIds": [
      123
    ]
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute cbinsights_post_v2_businessrelationships --input '{
  "orgIds": [
    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": {
    "nextPageToken": "example",
    "orgs": [
      {
        "businessRelationships": [
          {}
        ],
        "orgId": 123
      }
    ]
  }
}
```

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

## Input reference

Search parameters to request business relationship information one or more organizations

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.nextPageToken` | `string` | No | — | Token to fetch the next page of results. provided in a previous response. |
| `payload.orgIds` | `array` | Yes | — | CB Insights organization IDs to return. Minimum items: 1. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Search parameters to request business relationship information one or more organizations",
    "properties": {
      "nextPageToken": {
        "type": "string",
        "description": "Token to fetch the next page of results; provided in a previous response."
      },
      "orgIds": {
        "type": "array",
        "description": "CB Insights organization IDs to return.",
        "minItems": 1,
        "items": {
          "type": "integer"
        }
      }
    },
    "required": [
      "orgIds"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.nextPageToken` | `string` | No | — | Token to fetch the next page of results. If the value is null, then there are no more results to page through. |
| `result.data.orgs` | `array` | No | — | A list of organizations with their business relationship details included. |
| `result.data.orgs[].businessRelationships` | `array` | No | — | A list of items containing details regarding a business relationship for a given organization. |
| `result.data.orgs[].businessRelationships[].insights` | `object` | No | — | — |
| `result.data.orgs[].businessRelationships[].insights.details` | `array` | No | — | The list of insights regarding this relationship. |
| `result.data.orgs[].businessRelationships[].insights.headline` | `string` | No | — | The headline summarizing these insights. |
| `result.data.orgs[].businessRelationships[].insights.sources` | `array` | No | — | A list of sources the insights are based on. |
| `result.data.orgs[].businessRelationships[].lastUpdateTime` | `string` | No | — | — |
| `result.data.orgs[].businessRelationships[].newsSnippet` | `object` | No | — | — |
| `result.data.orgs[].businessRelationships[].newsSnippet.content` | `string` | No | — | A small portion of the news article about this business relationship. |
| `result.data.orgs[].businessRelationships[].newsSnippet.title` | `string` | No | — | The title of the news article about this business relationship. |
| `result.data.orgs[].businessRelationships[].newsSnippet.url` | `string` | No | — | The URL of the news source about this business relationship. |
| `result.data.orgs[].businessRelationships[].partners` | `array` | No | — | A list of business partners involved. |
| `result.data.orgs[].businessRelationships[].partners[].country` | `string` | No | — | The country where the partner's headquarters is located. |
| `result.data.orgs[].businessRelationships[].partners[].name` | `string` | No | — | The name of the partner organization. |
| `result.data.orgs[].businessRelationships[].partners[].orgId` | `integer` | No | — | The CB Insights organization ID of this partner. |
| `result.data.orgs[].businessRelationships[].partners[].role` | `string` | No | — | The role that this business partner plays in the relationship (Partner, Vendor, Client, Licensor, Licensee, Supplier, Distributor, Sponsor, Sponsored). |
| `result.data.orgs[].businessRelationships[].relationshipId` | `integer` | No | — | A unique ID which identifies this relationship. |
| `result.data.orgs[].businessRelationships[].sources` | `array` | No | — | A list of sources of information about this business relationship. |
| `result.data.orgs[].businessRelationships[].sources[].date` | `string` | No | — | The date this source was published. |
| `result.data.orgs[].businessRelationships[].sources[].title` | `string` | No | — | The title of this source. |
| `result.data.orgs[].businessRelationships[].sources[].url` | `string` | No | — | The URL pointing to this source. |
| `result.data.orgs[].businessRelationships[].startDate` | `string` | No | — | The date when this business relationship began (YYYY-MM-DD). |
| `result.data.orgs[].orgId` | `integer` | No | — | CB Insights organization ID. |
| `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": {
          "nextPageToken": {
            "type": "string",
            "description": "Token to fetch the next page of results. If the value is null, then there are no more results to page through."
          },
          "orgs": {
            "type": "array",
            "description": "A list of organizations with their business relationship details included.",
            "items": {
              "type": "object",
              "properties": {
                "businessRelationships": {
                  "type": "array",
                  "description": "A list of items containing details regarding a business relationship for a given organization.",
                  "items": {
                    "type": "object",
                    "properties": {
                      "insights": {
                        "type": "object",
                        "properties": {
                          "details": {
                            "type": "array",
                            "description": "The list of insights regarding this relationship.",
                            "items": {
                              "type": "string"
                            }
                          },
                          "headline": {
                            "type": "string",
                            "description": "The headline summarizing these insights."
                          },
                          "sources": {
                            "type": "array",
                            "description": "A list of sources the insights are based on.",
                            "items": {
                              "type": "string"
                            }
                          }
                        },
                        "additionalProperties": false
                      },
                      "lastUpdateTime": {
                        "type": "string"
                      },
                      "newsSnippet": {
                        "type": "object",
                        "properties": {
                          "content": {
                            "type": "string",
                            "description": "A small portion of the news article about this business relationship."
                          },
                          "title": {
                            "type": "string",
                            "description": "The title of the news article about this business relationship."
                          },
                          "url": {
                            "type": "string",
                            "description": "The URL of the news source about this business relationship."
                          }
                        },
                        "additionalProperties": false
                      },
                      "partners": {
                        "type": "array",
                        "description": "A list of business partners involved.",
                        "items": {
                          "type": "object",
                          "properties": {
                            "country": {
                              "type": "string",
                              "description": "The country where the partner's headquarters is located."
                            },
                            "name": {
                              "type": "string",
                              "description": "The name of the partner organization."
                            },
                            "orgId": {
                              "type": "integer",
                              "description": "The CB Insights organization ID of this partner."
                            },
                            "role": {
                              "type": "string",
                              "description": "The role that this business partner plays in the relationship (Partner, Vendor, Client, Licensor, Licensee, Supplier, Distributor, Sponsor, Sponsored)."
                            }
                          },
                          "additionalProperties": false
                        }
                      },
                      "relationshipId": {
                        "type": "integer",
                        "description": "A unique ID which identifies this relationship."
                      },
                      "sources": {
                        "type": "array",
                        "description": "A list of sources of information about this business relationship.",
                        "items": {
                          "type": "object",
                          "properties": {
                            "date": {
                              "type": "string",
                              "description": "The date this source was published."
                            },
                            "title": {
                              "type": "string",
                              "description": "The title of this source."
                            },
                            "url": {
                              "type": "string",
                              "description": "The URL pointing to this source."
                            }
                          },
                          "additionalProperties": false
                        }
                      },
                      "startDate": {
                        "type": "string",
                        "description": "The date when this business relationship began (YYYY-MM-DD)."
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "orgId": {
                  "type": "integer",
                  "description": "CB Insights organization ID."
                }
              },
              "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

* [CB Insights provider guide](https://deepline.com/docs/providers/cbinsights/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.