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

# ZoomInfo: Action Doc

> Enrich Corporate Hierarchy. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost.

Enrich Corporate Hierarchy.

<Info>
  Tool ID: `zoominfo_enrich_corporate_hierarchy`
</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(
  'zoominfo_enrich_corporate_hierarchy',
  {
    "data": {
      "type": "CorporateHierarchyEnrich",
      "attributes": {
        "outputFields": [
          "email"
        ],
        "matchCompanyInput": [
          {
            "companyId": 123,
            "companyName": "Example Corp",
            "companyWebsite": "https://example.com"
          }
        ]
      }
    }
  },
);

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

### CLI

```bash theme={null}
deepline tools execute zoominfo_enrich_corporate_hierarchy --input '{
  "data": {
    "type": "CorporateHierarchyEnrich",
    "attributes": {
      "outputFields": [
        "email"
      ],
      "matchCompanyInput": [
        {
          "companyId": 123,
          "companyName": "Example Corp",
          "companyWebsite": "https://example.com"
        }
      ]
    }
  }
}' --json
```

## Example response

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

```json theme={null}
{
  "data": {
    "data": [
      {
        "id": "id_123",
        "type": "CorporateHierarchy",
        "attributes": {}
      }
    ]
  }
}
```

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

## Input reference

Corporate hierarchy enrich request.

| Name           | Type     | Required | Default | Details                                      |
| -------------- | -------- | -------- | ------- | -------------------------------------------- |
| `payload.data` | `object` | Yes      | —       | Corporate hierarchy enrich request resource. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Corporate hierarchy enrich request.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Corporate hierarchy enrich request resource.",
        "properties": {
          "type": {
            "type": "string",
            "description": "The type of the resource",
            "default": "CorporateHierarchyEnrich",
            "pattern": "CorporateHierarchyEnrich"
          },
          "attributes": {
            "type": "object",
            "description": "Corporate hierarchy enrich request attributes.",
            "properties": {
              "outputFields": {
                "type": "array",
                "description": "List of fields to be returned in the response.",
                "items": {
                  "type": "string"
                }
              },
              "matchCompanyInput": {
                "type": "array",
                "description": "List of criteria to match against.",
                "minItems": 1,
                "maxItems": 25,
                "items": {
                  "type": "object",
                  "description": "Corporate hierarchy enrich request criteria.",
                  "properties": {
                    "companyId": {
                      "type": "integer",
                      "description": "Unique ZoomInfo identifier for a company.",
                      "format": "int64"
                    },
                    "companyName": {
                      "type": "string",
                      "description": "Company name."
                    },
                    "companyWebsite": {
                      "type": "string",
                      "description": "Company website URL in http://www.example.com format."
                    }
                  },
                  "additionalProperties": false
                }
              }
            },
            "required": [
              "outputFields",
              "matchCompanyInput"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "type",
          "attributes"
        ],
        "additionalProperties": false
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name                                                                                       | Type                                                                | Required | Default                | Details                                                                                                                                                                                                                                          |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------- | -------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `result.data`                                                                              | `object`                                                            | Yes      | —                      | Corporate hierarchy enrich response.                                                                                                                                                                                                             |
| `result.data.data`                                                                         | `array`                                                             | Yes      | —                      | The primary data of the document                                                                                                                                                                                                                 |
| `result.data.data[].id`                                                                    | `string`                                                            | Yes      | —                      | The unique identifier for the resource                                                                                                                                                                                                           |
| `result.data.data[].type`                                                                  | `string`                                                            | Yes      | `"CorporateHierarchy"` | The type of the resource                                                                                                                                                                                                                         |
| `result.data.data[].attributes`                                                            | `object`                                                            | Yes      | —                      | Corporate hierarchy enrich response attributes.                                                                                                                                                                                                  |
| `result.data.data[].attributes.companyId`                                                  | `integer`                                                           | No       | —                      | Unique ZoomInfo identifier for a company.                                                                                                                                                                                                        |
| `result.data.data[].attributes.parentage`                                                  | `array`                                                             | No       | —                      | Lists companies higher up in the corporate hierarchy for this company.                                                                                                                                                                           |
| `result.data.data[].attributes.parentage[].city`                                           | `string`                                                            | No       | —                      | City of the company's primary address.                                                                                                                                                                                                           |
| `result.data.data[].attributes.parentage[].state`                                          | `string`                                                            | No       | —                      | State or province of the company's primary address.                                                                                                                                                                                              |
| `result.data.data[].attributes.parentage[].companyId`                                      | `string`                                                            | No       | —                      | Unique ZoomInfo identifier for a company.                                                                                                                                                                                                        |
| `result.data.data[].attributes.parentage[].companyName`                                    | `string`                                                            | No       | —                      | Company name.                                                                                                                                                                                                                                    |
| `result.data.data[].attributes.parentage[].subUnitType`                                    | `string`                                                            | No       | —                      | Company sub types (e.g., division, subsidiary). Use this in conjunction with parentId or ultimateParentId.                                                                                                                                       |
| `result.data.data[].attributes.parentage[].subUnitDesc`                                    | `string`                                                            | No       | —                      | Contains a description of the sub unit listed in the corporate hierarchy.                                                                                                                                                                        |
| `result.data.data[].attributes.parentage[].acquiredByDate`                                 | `string`                                                            | No       | —                      | Denotes the date when the parent company acquired the input company if available.                                                                                                                                                                |
| `result.data.data[].attributes.familyTree`                                                 | `array`                                                             | No       | —                      | Lists companies and locations in the family tree for this company.                                                                                                                                                                               |
| `result.data.data[].attributes.familyTree[].city`                                          | `string`                                                            | No       | —                      | City of the company's primary address.                                                                                                                                                                                                           |
| `result.data.data[].attributes.familyTree[].state`                                         | `string`                                                            | No       | —                      | State or province of the company's primary address.                                                                                                                                                                                              |
| `result.data.data[].attributes.familyTree[].companyId`                                     | `integer`                                                           | No       | —                      | Unique ZoomInfo identifier for a company.                                                                                                                                                                                                        |
| `result.data.data[].attributes.familyTree[].name`                                          | `string`                                                            | No       | —                      | Company name.                                                                                                                                                                                                                                    |
| `result.data.data[].attributes.familyTree[].familyNodes`                                   | `array`                                                             | No       | —                      | Denotes a branch or sub-branch of the family tree within the corporate hierarchy.                                                                                                                                                                |
| `result.data.data[].attributes.familyTree[].familyNodes[].city`                            | `string`                                                            | No       | —                      | City of the company's primary address.                                                                                                                                                                                                           |
| `result.data.data[].attributes.familyTree[].familyNodes[].state`                           | `string`                                                            | No       | —                      | State or province of the company's primary address.                                                                                                                                                                                              |
| `result.data.data[].attributes.familyTree[].familyNodes[].name`                            | `string`                                                            | No       | —                      | Company name.                                                                                                                                                                                                                                    |
| `result.data.data[].attributes.familyTree[].familyNodes[].companyId`                       | `integer`                                                           | No       | —                      | Unique ZoomInfo identifier for a company.                                                                                                                                                                                                        |
| `result.data.data[].attributes.familyTree[].familyNodes[].subUnitTypeInfo`                 | `object`                                                            | Yes      | —                      | Denotes the type of sub-unit represented by a family node within the corporate hierarchy.                                                                                                                                                        |
| `result.data.data[].attributes.familyTree[].familyNodes[].subUnitTypeInfo.typeId`          | `integer`                                                           | No       | —                      | ID of the sub unit type.                                                                                                                                                                                                                         |
| `result.data.data[].attributes.familyTree[].familyNodes[].subUnitTypeInfo.typeDescription` | `string`                                                            | Yes      | —                      | Description of the sub unit type.                                                                                                                                                                                                                |
| `result.data.data[].attributes.familyTree[].familyNodes[].familyNodes`                     | `array`                                                             | No       | —                      | Denotes a branch or sub-branch of the family tree within the corporate hierarchy.                                                                                                                                                                |
| `result.data.data[].meta`                                                                  | `object`                                                            | No       | —                      | Metadata describing the result of a corporate hierarchy enrich match, including the match status and the input criteria used for the match. Used to provide additional context about how the corporate hierarchy enrich response was determined. |
| `result.data.data[].meta.matchStatus`                                                      | `"FULL_MATCH" \| "NO_MATCH" \| "LIMIT_EXCEEDED" \| "INVALID_INPUT"` | Yes      | —                      | —                                                                                                                                                                                                                                                |
| `result.data.data[].meta.input`                                                            | `object`                                                            | Yes      | —                      | Corporate hierarchy enrich request criteria.                                                                                                                                                                                                     |
| `result.data.data[].meta.input.companyId`                                                  | `integer`                                                           | No       | —                      | Unique ZoomInfo identifier for a company.                                                                                                                                                                                                        |
| `result.data.data[].meta.input.companyName`                                                | `string`                                                            | No       | —                      | Company name.                                                                                                                                                                                                                                    |
| `result.data.data[].meta.input.companyWebsite`                                             | `string`                                                            | No       | —                      | Company website URL in [http://www.example.com](http://www.example.com) format.                                                                                                                                                                  |
| `result.data.data[].meta.warnings`                                                         | `array`                                                             | No       | —                      | Details about any warnings encountered during the validation of the enrich request input criteria.                                                                                                                                               |
| `result.data.data[].meta.warnings[].code`                                                  | `string`                                                            | No       | —                      | Warning code.                                                                                                                                                                                                                                    |
| `result.data.data[].meta.warnings[].message`                                               | `string`                                                            | No       | —                      | Warning message.                                                                                                                                                                                                                                 |
| `result.data.data[].meta.warnings[].fields`                                                | `array`                                                             | No       | —                      | Fields associated with the warning.                                                                                                                                                                                                              |
| `result.meta`                                                                              | `object`                                                            | No       | —                      | Additional response metadata (status, paging).                                                                                                                                                                                                   |

<Info>
  This output schema is too large to embed without slowing the page. Get the complete live contract with `deepline tools get zoominfo_enrich_corporate_hierarchy --json`.
</Info>

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

* [ZoomInfo provider guide](/docs/providers/zoominfo/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)
