ZoomInfo: Action Doc

Enrich Corporate Hierarchy.

Tool ID: zoominfo_enrich_corporate_hierarchy

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.

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

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.

{
  "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.

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

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.

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

Get started

Build and automate

Common workflows

Data and integrations

Reference

ZoomInfo: Action Doc

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation