---
canonical_url: "https://docs.composio.dev/toolkits/harmonic"
markdown_url: "https://docs.composio.dev/toolkits/harmonic.md"
product: "platform"
version: null
last_updated: null
---

# Harmonic

Harmonic provides company and people data, enrichment, discovery, saved searches, and workspace operations for go-to-market and investment workflows.

- **Category:** sales & crm
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 76
- **Triggers:** 0
- **Slug:** `HARMONIC`
- **Version:** 00000000_00

## Tools

### Batch Delete Company Attachments

**Slug:** `HARMONIC_BATCH_DELETE_COMPANY_ATTACHMENTS`

OFFICIAL MIGRATION-DOC CONFLICT: Harmonic's migration documentation retires adjacent v1 attachment flows but does not document this owner-retained collection route. This action follows the current OpenAPI operation exactly and has not been live-verified. Do not infer support for retired single-item, initiate-upload, or complete-upload routes. Delete the supplied company attachment URNs in one collection request; the response is the integer number deleted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attachment_urns` | array | Yes | Harmonic user-uploaded-content URNs to delete or link. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch Delete Investor Attachments

**Slug:** `HARMONIC_BATCH_DELETE_INVESTOR_ATTACHMENTS`

Delete multiple investor attachments and return the deleted count. This is destructive, requires the paid investor/deal-data add-on, and has not been live verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attachment_urns` | array | Yes | Attachment URNs to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch Delete Person Attachments

**Slug:** `HARMONIC_BATCH_DELETE_PERSON_ATTACHMENTS`

OFFICIAL MIGRATION-DOC CONFLICT: Harmonic's migration documentation retires adjacent v1 attachment flows but does not document this owner-retained collection route. This action follows the current OpenAPI operation exactly and has not been live-verified. Do not infer support for retired single-item, initiate-upload, or complete-upload routes. Delete the supplied person attachment URNs in one collection request; the response is the integer number deleted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attachment_urns` | array | Yes | Harmonic user-uploaded-content URNs to delete or link. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch Get Companies

**Slug:** `HARMONIC_BATCH_GET_COMPANIES`

Return up to 500 Harmonic companies by numeric IDs and company URNs using the JSON-body batch endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Numeric Harmonic company IDs. |
| `urns` | array | No | Harmonic company URNs. |
| `extended` | boolean | No | Whether to request the extended company representation. |
| `include_fields` | array | No | Fields to populate. Other profile fields are returned as null when this filter is used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch Get Investor Attachments

**Slug:** `HARMONIC_BATCH_GET_INVESTOR_ATTACHMENTS`

Return attachment metadata for Harmonic investors. Requires the paid investor/deal-data add-on; this route has not been live verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_urns` | array | Yes | Investor URNs whose attachment metadata to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch Get Persons

**Slug:** `HARMONIC_BATCH_GET_PERSONS`

Return up to 500 Harmonic people by numeric IDs and person URNs using the JSON-body batch endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Numeric Harmonic person IDs. |
| `urns` | array | No | Harmonic person URNs. |
| `include_fields` | array | No | Person fields to populate. Other profile fields are returned as null when this filter is used. |
| `company_context_urns` | array | No | Company URNs used to provide company context for returned people. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch Get Workspace Records

**Slug:** `HARMONIC_BATCH_GET_WORKSPACE_RECORDS`

Fetch documented core fields and requested typed attribute values for multiple Workspace records of one record type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urns` | array | Yes | Workspace record URNs to fetch. |
| `include` | array | No | Record attribute URNs whose typed values should be returned. |
| `record_type_urn` | string | Yes | Record type URN shared by all requested records. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clear Saved Search Net-New Results

**Slug:** `HARMONIC_CLEAR_SAVED_SEARCH_NET_NEW_RESULTS`

Clear net-new state for selected company or person URNs in a shared saved search. DANGER: if entity_urns is omitted, Harmonic clears ALL net-new state for the saved search. This mutation has not been live-tested.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id_or_urn` | string | Yes | Numeric ID, UUID, or URN of the saved search. |
| `entity_urns` | array | No | Company or person URNs to clear. DANGER: omit this field to clear ALL net-new result state for the saved search. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Complete Investor Attachment Uploads

**Slug:** `HARMONIC_COMPLETE_INVESTOR_ATTACHMENT_UPLOADS`

Finalize investor attachments after their bytes were sent to upload_uri values returned by initiation. This call does not upload bytes. Requires the paid investor/deal-data add-on and has not been live verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id_or_urn` | string | Yes | Numeric investor ID, UUID, or Harmonic investor URN. |
| `attachment_urns` | array | Yes | URNs returned by initiation after their bytes have been uploaded. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Import

**Slug:** `HARMONIC_CREATE_IMPORT`

Start an asynchronous import of up to 1,000 rows into exactly one list or record type. UPSERT overwrites matching attribute values; poll the returned task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mode` | string ("INSERT" | "UPSERT") | No | INSERT avoids overwrites; UPSERT updates matching attribute values. |
| `rows` | array | Yes | Rows to import; Harmonic accepts at most 1,000. |
| `list_urn` | string | No | Target list; resolved records become list entries. |
| `file_name` | string | No | Optional source-file label. |
| `source_system` | string | No | Documented source system for API imports. |
| `record_type_urn` | string | No | Target record type for an import without list membership. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create List

**Slug:** `HARMONIC_CREATE_LIST`

Create a shared Workspace list for one record type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the new list. |
| `record_type_urn` | string | Yes | Record type tracked by the new list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Workspace List Attribute

**Slug:** `HARMONIC_CREATE_LIST_ATTRIBUTE`

Create a list-entry field from the documented metadata subset: numeric, currency, traction, select, status, or owner reference. Other field metadata shapes require authenticated introspection and are intentionally not exposed. Select/status options receive stable keys; use those keys, not labels, when writing values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_urn` | string | Yes | Workspace list on which to create the attribute. |
| `field_name` | string | Yes | Unique field name within the record type or list. |
| `field_type` | string ("NUMBER" | "CURRENCY" | "TRACTION" | "SINGLE_SELECT" | "MULTI_SELECT" | "STATUS" | "OWNER_REFERENCE") | Yes | Field type from the documented metadata subset: NUMBER, CURRENCY, TRACTION, SINGLE_SELECT, MULTI_SELECT, STATUS, or OWNER_REFERENCE. |
| `field_metadata` | object | Yes | Exactly one metadata block matching field_type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create List Entries

**Slug:** `HARMONIC_CREATE_LIST_ENTRIES`

Copy one explicit or filtered selection into a target list. Existing target members are skipped. Use imports, not this action, for canonical identifiers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `selection` | object | Yes | Exactly one documented bulk selector. |
| `target_list_urn` | string | Yes | List that will receive the memberships. |
| `attribute_values` | array | No | Optional values to set on created memberships. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create List Entry

**Slug:** `HARMONIC_CREATE_LIST_ENTRY`

Add one record to a Workspace list and optionally set values. A harmonic_urn may create the underlying Workspace record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `selection` | object | Yes | Target list plus exactly one existing record or Harmonic entity. |
| `attribute_values` | array | No | Optional initial record-level or list-level attribute values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Named View

**Slug:** `HARMONIC_CREATE_NAMED_VIEW`

Create a saved Workspace view for exactly one list or record type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Saved view name. |
| `sorts` | array | No | Saved sorts. |
| `filter` | object | No | Saved-view filter wrapped in exactly one top-level and/or array. AttributeFilterInput object. Each condition is keyed by its field family (for example text, number, status, or harmonicUrn) and contains attributeURN plus a documented operator. Example: {'status': {'attributeURN': 'urn:harmonic:list_attribute:...', 'in': ['OPTION_KEY']}}. Conditions at one level are ANDed; nest and/or arrays for grouped logic. Select and status operators use option keys, not labels. |
| `columns` | array | No | Columns in display order. |
| `list_urn` | string | No | Owning list URN. |
| `is_default` | boolean | No | Make this the default view for its owner. |
| `description` | string | No | Saved view description. |
| `record_type_urn` | string | No | Owning record type URN. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Record Attachment

**Slug:** `HARMONIC_CREATE_RECORD_ATTACHMENT`

Upload one file of at most 500 MB to a Workspace record. The returned content URL is short-lived and should be downloaded rather than cached.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | One file to upload, up to 500 MB. |
| `record` | string | Yes | Owning Workspace record URN. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Workspace Record Attribute

**Slug:** `HARMONIC_CREATE_RECORD_ATTRIBUTE`

Create a record-level field from the documented metadata subset: numeric, currency, traction, select, status, or owner reference. Other field metadata shapes require authenticated introspection and are intentionally not exposed. Select/status options receive stable keys; use those keys, not labels, when writing values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `field_name` | string | Yes | Unique field name within the record type or list. |
| `field_type` | string ("NUMBER" | "CURRENCY" | "TRACTION" | "SINGLE_SELECT" | "MULTI_SELECT" | "STATUS" | "OWNER_REFERENCE") | Yes | Field type from the documented metadata subset: NUMBER, CURRENCY, TRACTION, SINGLE_SELECT, MULTI_SELECT, STATUS, or OWNER_REFERENCE. |
| `field_metadata` | object | Yes | Exactly one metadata block matching field_type. |
| `record_type_urn` | string | Yes | Record type on which to create the attribute. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Saved Search

**Slug:** `HARMONIC_CREATE_SAVED_SEARCH`

Create a Harmonic saved search from an exact recursive filter, pagination, sort, and column-view configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the saved search. |
| `page` | integer | No | Initial page value stored with the saved search. |
| `type` | string ("EVENT_FEED" | "COMPANIES_LIST" | "PERSONS" | "TYPEAHEAD" | "INVESTORS") | No | Entity or search mode for the saved search. |
| `query` | object | Yes | Exact filters, pagination, sorting, and nested-query behavior to save. |
| `keywords` | string | Yes | Keyword text stored with the saved search. |
| `page_size` | integer | No | Initial page size stored with the saved search. |
| `is_private` | boolean | No | Whether the saved search is private rather than team-visible. |
| `visible_columns` | array | No | Field or attribute URNs shown as result columns. |
| `column_view_settings` | array | No | Optional display settings for individual result columns. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Scout Task

**Slug:** `HARMONIC_CREATE_SCOUT_TASK`

Create a Scout research task and immediately return its task_id and non-terminal status. Poll GET_SCOUT_TASK until success, error, timeout, or interrupted. Content is markdown unless json_schema requests an object. Scout task creation is paid, token-metered, and budget-capped. It is limited to 10 requests per minute and 100 per hour; exhausted budgets or limits return HTTP 429.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `input` | string | Yes | Natural-language prompt for Scout. |
| `json_schema` | object | No | Optional JSON Schema for structured object content instead of markdown. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Investor Attachment

**Slug:** `HARMONIC_DELETE_INVESTOR_ATTACHMENT`

Delete one investor attachment. This is destructive, requires the paid investor/deal-data add-on, and has not been live verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urn` | string | Yes | Attachment URN to delete. |
| `id_or_urn` | string | Yes | Numeric investor ID, UUID, or Harmonic investor URN. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete List

**Slug:** `HARMONIC_DELETE_LIST`

Delete a shared Workspace list. This is distinct from removing one membership.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urn` | string | Yes | List URN to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Workspace List Attribute

**Slug:** `HARMONIC_DELETE_LIST_ATTRIBUTE`

Permanently delete a custom list attribute by URN. The public narrative does not document deletion payload fields, so the response is limited to a GraphQL type acknowledgement.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urn` | string | Yes | List attribute URN to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete List Entries

**Slug:** `HARMONIC_DELETE_LIST_ENTRIES`

Remove an explicit or filtered selection of memberships from one list. The underlying Workspace records survive; this does not delete records. Filter-based selectors are capped at 10,000 items.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `selection` | object | Yes | Exactly one documented bulk selector. |
| `target_list_urn` | string | Yes | List from which memberships are removed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete List Entry

**Slug:** `HARMONIC_DELETE_LIST_ENTRY`

Remove one membership from a Workspace list. The underlying Workspace record survives; this does not delete the record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urn` | string | No | List-entry URN to remove. |
| `selection` | object | No | Owning list and record when the entry URN is unknown. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Named View

**Slug:** `HARMONIC_DELETE_NAMED_VIEW`

Permanently delete a Workspace named view.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urn` | string | Yes | Named view URN to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Record Attachment

**Slug:** `HARMONIC_DELETE_RECORD_ATTACHMENT`

Permanently delete a file attached to a Workspace record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `record` | string | Yes | Owning Workspace record URN. |
| `attachment` | string | Yes | Attachment URN to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Workspace Record Attribute

**Slug:** `HARMONIC_DELETE_RECORD_ATTRIBUTE`

Permanently delete a custom record attribute by URN. Read-only Harmonic attributes cannot be deleted. The public narrative does not document deletion payload fields, so the response is limited to a GraphQL type acknowledgement.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urn` | string | Yes | Record attribute URN to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enrich Company

**Slug:** `HARMONIC_ENRICH_COMPANY`

Find a company from web or social identifiers. When enrich_missing_company is true and no company exists, this may start asynchronous enrichment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `indeed_url` | string | No | Company Indeed profile URL. |
| `monster_url` | string | No | Company Monster profile URL. |
| `twitter_url` | string | No | Company Twitter URL. |
| `website_url` | string | No | Company website URL. |
| `facebook_url` | string | No | Company Facebook profile URL. |
| `linkedin_url` | string | No | Company LinkedIn profile URL. |
| `angellist_url` | string | No | Company AngelList profile URL. |
| `glassdoor_url` | string | No | Company Glassdoor profile URL. |
| `instagram_url` | string | No | Company Instagram profile URL. |
| `pitchbook_url` | string | No | Company, investor, or advisor PitchBook profile URL. |
| `crunchbase_url` | string | No | Company Crunchbase profile URL. |
| `include_fields` | array | No | Company fields to fetch; omit to use the provider's default field set. |
| `website_domain` | string | No | Company website domain. |
| `stackoverflow_url` | string | No | Company Stack Overflow profile URL. |
| `enrich_missing_company` | boolean | No | Request enrichment when the identifiers do not resolve to an existing company. |
| `hide_non_surfaceable_company` | boolean | No | Hide a company the provider considers non-surfaceable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enrich Person

**Slug:** `HARMONIC_ENRICH_PERSON`

Find a person by LinkedIn profile URL, with email used as a fallback. This may start asynchronous enrichment and returns null when no person is found.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Email address used as a fallback when linkedin_url is absent or returns no result. |
| `linkedin_url` | string | No | Person's LinkedIn profile URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export List CSV

**Slug:** `HARMONIC_EXPORT_LIST_CSV`

Stream a Workspace list as CSV using selected columns and optional documented filters and sorts. Harmonic limits requests to 100 columns and five minutes. Its narrative says API-key exports have no row limit, while its embedded export spec documents a structured HTTP 400 row-limit error; that conflict is not live-verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sorts` | array | No | Sorts in priority order; each uses an attribute or metadata-field URN. |
| `filter` | object | No | AttributeFilterInput object. Each condition is keyed by its field family (for example text, number, status, or harmonicUrn) and contains attributeURN plus a documented operator. Example: {'status': {'attributeURN': 'urn:harmonic:list_attribute:...', 'in': ['OPTION_KEY']}}. Conditions at one level are ANDed; nest and/or arrays for grouped logic. Select and status operators use option keys, not labels. |
| `columns` | array | No | Columns to export, in order. Harmonic allows at most 100 columns. |
| `list_urn` | string | Yes | URN of the Workspace list to export. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Named View CSV

**Slug:** `HARMONIC_EXPORT_NAMED_VIEW_CSV`

Stream a saved Workspace named view as CSV using its stored columns, filter, and sorts. Harmonic bounds the request by a five-minute provider limit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_urn` | string | Yes | Named-view URN. Harmonic loads the saved columns, filter, and sorts and dispatches record_named_view URNs to record-type export. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Record Type CSV

**Slug:** `HARMONIC_EXPORT_RECORD_TYPE_CSV`

Stream Workspace records of one record type as CSV using selected columns and optional documented filters and sorts. Harmonic limits requests to 100 columns and five minutes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sorts` | array | No | Sorts in priority order; each uses an attribute or metadata-field URN. |
| `filter` | object | No | AttributeFilterInput object. Each condition is keyed by its field family (for example text, number, status, or harmonicUrn) and contains attributeURN plus a documented operator. Example: {'status': {'attributeURN': 'urn:harmonic:list_attribute:...', 'in': ['OPTION_KEY']}}. Conditions at one level are ANDed; nest and/or arrays for grouped logic. Select and status operators use option keys, not labels. |
| `columns` | array | No | Columns to export, in order. Harmonic allows at most 100 columns. |
| `record_type_urn` | string | Yes | URN of the Workspace record type to export. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bulk Email Enrichment Job

**Slug:** `HARMONIC_GET_BULK_EMAIL_ENRICHMENT_JOB`

Read one paid bulk email enrichment job and its credit-consuming work status. Results remain null until the job is COMPLETED or FAILED; this action performs one poll and does not consume additional enrichment credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Bulk email enrichment job ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bulk Email Enrichment Usage

**Slug:** `HARMONIC_GET_BULK_EMAIL_ENRICHMENT_USAGE`

Return the paid bulk email enrichment product's current monthly credit usage, limit, and remaining balance. The quota resets at the start of each calendar month; this read does not purchase or consume credits.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Companies

**Slug:** `HARMONIC_GET_COMPANIES`

Return up to 50 Harmonic companies by numeric IDs and company URNs using the repeated-query GET endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Numeric Harmonic company IDs. Values are sent as repeated query parameters. |
| `urns` | array | No | Harmonic company URNs. Values are sent as repeated query parameters. |
| `extended` | boolean | No | Whether to request the extended company representation. |
| `include_fields` | array | No | Fields to populate. Other profile fields are returned as null when this filter is used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Company

**Slug:** `HARMONIC_GET_COMPANY`

Return one Harmonic company by its numeric ID, UUID, or company URN.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `extended` | boolean | No | Whether to request the extended company representation. |
| `id_or_urn` | string | Yes | Numeric company ID, UUID, or Harmonic company URN. |
| `include_fields` | array | No | Company fields to include in the response. Omit this parameter to use Harmonic's default field set. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Company User Connections

**Slug:** `HARMONIC_GET_COMPANY_USER_CONNECTIONS`

Return the workspace users connected to a Harmonic company and the email, calendar, or LinkedIn sources establishing each connection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id_or_urn` | string | Yes | Numeric company ID, UUID, or Harmonic company URN. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Enrichment Status

**Slug:** `HARMONIC_GET_ENRICHMENT_STATUS`

Check enrichment jobs by enrichment UUID or enrichment URN and return their current statuses.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Enrichment request UUIDs to check. |
| `urns` | array | No | Harmonic enrichment URNs to check. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Import Task

**Slug:** `HARMONIC_GET_IMPORT_TASK`

Poll an asynchronous Workspace import and return one optionally status-filtered Relay page of row results. SUCCESS and FAILED are terminal task outcomes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urn` | string | Yes | Import task URN. |
| `after` | string | No | Opaque import-entry end cursor from the previous page. |
| `first` | integer | No | Maximum import entries to return. |
| `status` | string ("PROCESSING" | "SUCCESS" | "FAILED") | No | Optional documented row-status filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Investor Attachment Content

**Slug:** `HARMONIC_GET_INVESTOR_ATTACHMENT_CONTENT`

Return Harmonic's short-lived content URL as a downloadable file reference. Requires the paid investor/deal-data add-on and has not been live verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urn` | string | Yes | Attachment URN whose content to access. |
| `preview` | boolean | No | Whether to request Harmonic's preview representation instead of the original. |
| `id_or_urn` | string | Yes | Numeric investor ID, UUID, or Harmonic investor URN. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Named View

**Slug:** `HARMONIC_GET_NAMED_VIEW`

Return a saved Workspace view's documented filter, columns, sorts, default state, and owning list or record type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urn` | string | Yes | Named view URN. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Person

**Slug:** `HARMONIC_GET_PERSON`

Return one Harmonic person by numeric ID, UUID, or person URN, optionally using company URNs to provide company context. Returns null when the provider does not return a person.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id_or_urn` | string | Yes | Numeric person ID, UUID, or Harmonic person URN. |
| `company_context_urns` | array | No | Harmonic company URNs used to provide company context for the person response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Persons

**Slug:** `HARMONIC_GET_PERSONS`

Return up to 50 Harmonic people by numeric IDs and person URNs using the repeated-query GET endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Numeric Harmonic person IDs. Values are sent as repeated query parameters. |
| `urns` | array | No | Harmonic person URNs. Values are sent as repeated query parameters. |
| `company_context_urns` | array | No | Company URNs used to provide company context for returned people. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Record Type

**Slug:** `HARMONIC_GET_RECORD_TYPE`

Return a Workspace record type, its documented attributes, and one Relay page of records. Pass end_cursor back as after to continue.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urn` | string | Yes | Record type URN. |
| `after` | string | No | Opaque records end cursor from the previous page. |
| `first` | integer | No | Maximum records to return on this page. |
| `filter` | object | No | AttributeFilterInput object. Each condition is keyed by its field family (for example text, number, status, or harmonicUrn) and contains attributeURN plus a documented operator. Example: {'status': {'attributeURN': 'urn:harmonic:list_attribute:...', 'in': ['OPTION_KEY']}}. Conditions at one level are ANDed; nest and/or arrays for grouped logic. Select and status operators use option keys, not labels. |
| `order_by` | array | No | SortInput objects in priority order. Each object sets exactly one of metadataField (ID, NAME, CREATED_AT, UPDATED_AT, CREATED_BY, or SEARCH_RANK) or sortOrderUrn (an attribute or metadata-field URN), plus optional descending. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Saved Search Net-New Results

**Slug:** `HARMONIC_GET_SAVED_SEARCH_NET_NEW_RESULTS`

Return one page of entities newly matching a shared Harmonic saved search. A new_results_since value includes matching entities even if they were cleared.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum results in this page (1-1000). |
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `id_or_urn` | string | Yes | Numeric ID, UUID, or URN of the saved search. |
| `hydrate_entities` | boolean | No | Whether to hydrate entity URNs into entity objects. |
| `new_results_since` | string | No | UTC date (YYYY-MM-DD) or hour-aligned datetime (YYYY-MM-DDTHH:00:00Z). Returns matches regardless of cleared state. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Saved Search Results

**Slug:** `HARMONIC_GET_SAVED_SEARCH_RESULTS`

Return one page of company, person, user, or investor results from a saved search, optionally hydrated into entity objects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Legacy zero-based page number; prefer cursor continuation. |
| `size` | integer | No | Maximum number of results to request in this page (1-1000). |
| `cursor` | string | No | Continuation value returned as next_cursor by a previous call. |
| `id_or_urn` | string | Yes | Numeric saved-search ID, UUID, or Harmonic saved-search URN. |
| `hydrate_entities` | boolean | No | Whether to hydrate result URNs into company or person entity objects when supported. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Scout API Usage

**Slug:** `HARMONIC_GET_SCOUT_API_USAGE`

Return one page of usage for existing Scout API runs. Scout is a paid, token-metered and budget-capped product; token counts and dollar costs can receive late updates. This read-only action never creates a Scout task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `status` | string ("pending" | "success" | "error") | No | Filter by the aggregated Scout run status. |
| `task_id` | string | No | Filter to one existing Scout task ID. |
| `page_size` | integer | No | Number of Scout runs to return (1-100). |
| `started_after` | string | No | Include runs started at or after this datetime. |
| `started_before` | string | No | Include runs started before this datetime. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Scout Task

**Slug:** `HARMONIC_GET_SCOUT_TASK`

Poll an existing Scout task until its status is terminal. Content is null before success, then contains markdown or the structured object requested at creation. This read does not create or replay a task. Scout task creation is paid, token-metered, and budget-capped. It is limited to 10 requests per minute and 100 per hour; exhausted budgets or limits return HTTP 429.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Opaque Scout task ID. Pass it back unchanged. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Similar Companies

**Slug:** `HARMONIC_GET_SIMILAR_COMPANIES`

Return Harmonic company URNs ranked as similar to a source company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Number of similar companies (1-100). |
| `id_or_urn` | string | Yes | Numeric ID, UUID, or URN of the source company. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workspace

**Slug:** `HARMONIC_GET_WORKSPACE`

Return the connected team's Workspace identity, built-in record types, and documented Harmonic attribute catalogs.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workspace List

**Slug:** `HARMONIC_GET_WORKSPACE_LIST`

Return list metadata and one filtered, sorted Relay page of entries. Keep filter and order_by stable and pass end_cursor as after to continue.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urn` | string | Yes | Workspace list URN. |
| `after` | string | No | Opaque entries end cursor from the previous page. |
| `first` | integer | No | Maximum list entries to return. |
| `filter` | object | No | AttributeFilterInput object. Each condition is keyed by its field family (for example text, number, status, or harmonicUrn) and contains attributeURN plus a documented operator. Example: {'status': {'attributeURN': 'urn:harmonic:list_attribute:...', 'in': ['OPTION_KEY']}}. Conditions at one level are ANDed; nest and/or arrays for grouped logic. Select and status operators use option keys, not labels. |
| `include` | array | No | Record or list attribute URNs whose typed values should be returned. |
| `order_by` | array | No | SortInput objects in priority order. Each object sets exactly one of metadataField (ID, NAME, CREATED_AT, UPDATED_AT, CREATED_BY, or SEARCH_RANK) or sortOrderUrn (an attribute or metadata-field URN), plus optional descending. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workspace List Entry

**Slug:** `HARMONIC_GET_WORKSPACE_LIST_ENTRY`

Return one list membership, its underlying record, and explicitly requested typed attribute values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urn` | string | Yes | List entry URN. |
| `include` | array | No | Record or list attribute URNs whose typed values should be returned. |
| `list_urn` | string | Yes | Owning list URN required to scope the entry. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workspace Record

**Slug:** `HARMONIC_GET_WORKSPACE_RECORD`

Return one scoped Workspace record with requested typed values, one attachment page, and documented update-event fields. Attachment content URLs are short-lived.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urn` | string | Yes | Workspace record URN. |
| `include` | array | No | Record attribute URNs whose typed values should be returned. |
| `record_type_urn` | string | Yes | Record type URN that scopes the record. |
| `attachments_after` | string | No | Opaque attachment end cursor from the previous page. |
| `attachments_first` | integer | No | Maximum attachments to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Initiate Investor Attachment Uploads

**Slug:** `HARMONIC_INITIATE_INVESTOR_ATTACHMENT_UPLOADS`

Create attachment metadata and presigned upload destinations for an investor. This metadata-only call does not upload bytes; upload bytes to each upload_uri, then call Complete Investor Attachment Uploads. Requires the paid investor/deal-data add-on and has not been live verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id_or_urn` | string | Yes | Numeric investor ID, UUID, or Harmonic investor URN. |
| `attachments` | array | Yes | Metadata for files to upload. This call does not accept file bytes; upload each file separately to the returned upload_uri. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Link Company Attachments

**Slug:** `HARMONIC_LINK_COMPANY_ATTACHMENTS`

OFFICIAL MIGRATION-DOC CONFLICT: Harmonic's migration documentation retires adjacent v1 attachment flows but does not document this owner-retained collection route. This action follows the current OpenAPI operation exactly and has not been live-verified. Do not infer support for retired single-item, initiate-upload, or complete-upload routes. Link the supplied existing attachment URNs to one company and return their attachment metadata. Returned upload_uri and link values may identify attachment content; use only the shared transport for subsequent authenticated requests.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id_or_urn` | string | Yes | Numeric company ID, UUID, or Harmonic company URN. |
| `attachment_urns` | array | Yes | Harmonic user-uploaded-content URNs to delete or link. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Link Investor Attachments

**Slug:** `HARMONIC_LINK_INVESTOR_ATTACHMENTS`

Link uploaded attachments to an investor. Requires the paid investor/deal-data add-on and has not been live verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id_or_urn` | string | Yes | Numeric investor ID, UUID, or Harmonic investor URN. |
| `attachment_urns` | array | Yes | Attachment URNs to link to the investor. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Link Person Attachments

**Slug:** `HARMONIC_LINK_PERSON_ATTACHMENTS`

OFFICIAL MIGRATION-DOC CONFLICT: Harmonic's migration documentation retires adjacent v1 attachment flows but does not document this owner-retained collection route. This action follows the current OpenAPI operation exactly and has not been live-verified. Do not infer support for retired single-item, initiate-upload, or complete-upload routes. Link the supplied existing attachment URNs to one person and return their attachment metadata. Returned upload_uri and link values may identify attachment content; use only the shared transport for subsequent authenticated requests.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id_or_urn` | string | Yes | Numeric person ID, UUID, or Harmonic person URN. |
| `attachment_urns` | array | Yes | Harmonic user-uploaded-content URNs to delete or link. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Company Employees

**Slug:** `HARMONIC_LIST_COMPANY_EMPLOYEES`

Return one page of person URNs associated with a company, filtered by employee group, status, or connection status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Legacy page number; ignored when cursor is provided. |
| `size` | integer | No | Number of employee URNs to request in this page. |
| `cursor` | string | No | Continuation value returned as next_cursor by a previous call. |
| `id_or_urn` | string | Yes | Numeric company ID, UUID, or Harmonic company URN. |
| `employee_status` | string ("ACTIVE" | "NOT_ACTIVE" | "ACTIVE_AND_NOT_ACTIVE") | No | Employment status to include. |
| `employee_group_type` | string ("CEO" | "FOUNDERS_AND_CEO" | "EXECUTIVES" | "FOUNDERS" | "LEADERSHIP" | "NON_LEADERSHIP" | "ALL" | "ADVISORS" | "NON_PARTNERS") | No | Employee group to include. |
| `user_connection_status` | string ("USER_CONNECTION" | "TEAM_CONNECTION" | "NO_CONNECTION") | No | Connection status to include. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Saved Searches

**Slug:** `HARMONIC_LIST_SAVED_SEARCHES`

Return the saved searches visible to the API key's team.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reconnect Scout Task Stream

**Slug:** `HARMONIC_RECONNECT_SCOUT_TASK_STREAM`

Reconnect to a Scout text/event-stream using the task_id emitted by the first event of STREAM_SCOUT_TASK. The bounded downloadable stream resumes from the task's current point; events emitted before reconnect are not replayed. This read does not create a task. Scout task creation is paid, token-metered, and budget-capped. It is limited to 10 requests per minute and 100 per hour; exhausted budgets or limits return HTTP 429.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Opaque Scout task ID. Pass it back unchanged. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Run Scout Task and Wait

**Slug:** `HARMONIC_RUN_SCOUT_TASK_AND_WAIT`

Create a Scout research task, hold the connection until it finishes, and return markdown or json_schema-structured content. Use this for quick tasks; long research should use CREATE_SCOUT_TASK and polling. Scout task creation is paid, token-metered, and budget-capped. It is limited to 10 requests per minute and 100 per hour; exhausted budgets or limits return HTTP 429.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `input` | string | Yes | Natural-language prompt for Scout. |
| `json_schema` | object | No | Optional JSON Schema for structured object content instead of markdown. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Companies by Keywords

**Slug:** `HARMONIC_SEARCH_COMPANIES_BY_KEYWORDS`

Search Harmonic companies with explicit keyword inclusion and exclusion fields. Use Search with Agent for natural-language discovery instead.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Zero-based page number. |
| `size` | integer | No | Maximum results in this page (1-1000). |
| `type` | string ("EVENT_FEED" | "COMPANIES_LIST" | "PERSONS" | "TYPEAHEAD" | "INVESTORS") | No | Harmonic search mode. |
| `keywords` | string | No | General keyword expression. |
| `include_ids_only` | boolean | No | Return company URNs only instead of hydrated companies. |
| `contains_all_of_keywords` | string | No | Keywords where every term must match. |
| `contains_any_of_keywords` | string | No | Keywords where any term may match. |
| `does_not_contain_keywords` | string | No | Keywords that matching companies must not contain. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Typeahead

**Slug:** `HARMONIC_SEARCH_TYPEAHEAD`

Return Harmonic typeahead suggestions for companies, people, investors, schools, users, or locations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Zero-based page number. |
| `size` | integer | No | Maximum suggestions in this page (1-500). |
| `query` | string | Yes | Text prefix to search for. |
| `source` | string | No | Optional provider source; only ENTERPRISE_APP is supported. |
| `search_type` | string ("PERSON" | "COMPANY" | "SCHOOL" | "EMAIL_INTEGRATED_USER" | "INVESTOR" | "INVESTOR_COMPANY" | "INVESTOR_PERSON" | "LOCATION" | "LOCATION_CITY" | "LOCATION_STATE" | "LOCATION_COUNTRY" | "LOCATION_METRO_AREA") | No | Optional entity category to search. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search with Agent

**Slug:** `HARMONIC_SEARCH_WITH_AGENT`

Search companies from a natural-language request and return Harmonic's parsed query interpretation. RATE LIMIT: this endpoint allows only 5 requests per minute. Each call fetches one cursor page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum results in this page (1-1000). |
| `query` | string | Yes | Natural-language company search request. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `similarity_threshold` | number | No | Minimum semantic similarity from 0 to 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Stream Scout Task

**Slug:** `HARMONIC_STREAM_SCOUT_TASK`

Create a Scout task, capture its mandatory first SSE task_id event, and close the initial stream immediately so the paid task is recoverable. Pass task_id to RECONNECT_SCOUT_TASK_STREAM to consume current and future events; events emitted before reconnect are not replayed. Streaming returns markdown chunks and does not accept json_schema. Scout task creation is paid, token-metered, and budget-capped. It is limited to 10 requests per minute and 100 per hour; exhausted budgets or limits return HTTP 429.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `input` | string | Yes | Natural-language prompt for Scout. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Submit Bulk Email Enrichment Job

**Slug:** `HARMONIC_SUBMIT_BULK_EMAIL_ENRICHMENT_JOB`

Submit 1-5,000 people for paid bulk email enrichment using exactly one identifier array. This action consumes monthly email enrichment credits, deduplicates people, and enforces a 30-day retry cooldown. A successful submission is asynchronous and returns HTTP 202.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `person_urns` | array | No | Harmonic person URNs to enrich (1-5000); omit person_linkedin_urls. |
| `allow_re_enrichment` | boolean | No | Re-run enrichment for people who already have email. Newly found addresses are added, but the 30-day cooldown still applies. |
| `person_linkedin_urls` | array | No | LinkedIn profile URLs to enrich (1-5000); omit person_urns. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update List

**Slug:** `HARMONIC_UPDATE_LIST`

Rename a shared Workspace list. No record memberships are changed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urn` | string | Yes | List URN to update. |
| `name` | string | Yes | New list name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Workspace List Attribute

**Slug:** `HARMONIC_UPDATE_LIST_ATTRIBUTE`

Rename a Workspace list attribute and/or update its documented numeric, currency, traction, select, or status metadata. Field type changes and option merge behavior are not exposed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urn` | string | Yes | Attribute URN to update. |
| `field_name` | string | No | Replacement field name. |
| `field_metadata` | object | No | Replacement metadata from the documented numeric, currency, traction, select, or status subset. Option merge behavior is not assumed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update List Entries

**Slug:** `HARMONIC_UPDATE_LIST_ENTRIES`

Set supplied attribute values on an explicit or filtered selection of list memberships. Filter-based selectors are capped at 10,000 items.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `selection` | object | Yes | Exactly one documented bulk selector. |
| `target_list_urn` | string | Yes | List containing the memberships to update. |
| `attribute_values` | array | Yes | Values to set on every selected membership. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update List Entry

**Slug:** `HARMONIC_UPDATE_LIST_ENTRY`

Update only the supplied attribute values on one list membership.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urn` | string | No | List-entry URN to update. |
| `selection` | object | No | Owning list and record when the entry URN is unknown. |
| `attribute_values` | array | Yes | Attribute values to change; omitted values remain unchanged. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Named View

**Slug:** `HARMONIC_UPDATE_NAMED_VIEW`

Update provided fields on a Workspace named view. Supplying columns or sorts replaces that entire set, including with an empty array.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urn` | string | Yes | Named view URN. |
| `name` | string | No | Replacement view name. |
| `sorts` | array | No | Complete replacement sort set. |
| `filter` | object | No | Replacement saved-view filter wrapped in exactly one top-level and/or array. AttributeFilterInput object. Each condition is keyed by its field family (for example text, number, status, or harmonicUrn) and contains attributeURN plus a documented operator. Example: {'status': {'attributeURN': 'urn:harmonic:list_attribute:...', 'in': ['OPTION_KEY']}}. Conditions at one level are ANDed; nest and/or arrays for grouped logic. Select and status operators use option keys, not labels. |
| `columns` | array | No | Complete replacement column set; array order is display order. |
| `is_default` | boolean | No | Set true to replace the owner's previous default view. |
| `description` | string | No | Replacement description. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Workspace Record

**Slug:** `HARMONIC_UPDATE_RECORD`

Update only the supplied record-level values and/or shared team note. STRING text is limited to 500 characters; select/status values use option keys.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urn` | string | Yes | Workspace record URN. |
| `team_note` | string | No | Shared team note to set; an empty string clears the note. |
| `attribute_values` | array | No | Record-level attribute values to change. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Record Attachment

**Slug:** `HARMONIC_UPDATE_RECORD_ATTACHMENT`

Rename a file attached to a Workspace record; file content is unchanged.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Replacement attachment display name. |
| `record` | string | Yes | Owning Workspace record URN. |
| `attachment` | string | Yes | Attachment URN to rename. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Workspace Record Attribute

**Slug:** `HARMONIC_UPDATE_RECORD_ATTRIBUTE`

Rename a Workspace record attribute and/or update its documented numeric, currency, traction, select, or status metadata. Field type changes and option merge behavior are not exposed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urn` | string | Yes | Attribute URN to update. |
| `field_name` | string | No | Replacement field name. |
| `field_metadata` | object | No | Replacement metadata from the documented numeric, currency, traction, select, or status subset. Option merge behavior is not assumed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Workspace Records

**Slug:** `HARMONIC_UPDATE_RECORDS`

Set record-level attribute values across one explicit or filtered Workspace selection. Filter selections are capped at 10,000; select/status values use stable option keys, not labels.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `selection` | object | Yes | Exactly one explicit or filter-based bulk selection. |
| `record_type_urn` | string | Yes | Record type URN for the record-level values. |
| `attribute_values` | array | Yes | Record-level attribute values to set on every selected record. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Workspace Team Note

**Slug:** `HARMONIC_UPDATE_TEAM_NOTE`

Set or clear a shared record note using a record URN or Harmonic entity URN. Selecting by Harmonic URN may resolve or create the underlying workspace record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note` | string | Yes | Shared team note; an empty string clears the note. |
| `selection` | object | Yes | Record type plus exactly one workspace record or Harmonic entity URN. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
