Harmonic REST & GraphQL API

REST API for company search, enrichment, saved searches, list management, and bulk operations, plus a full GraphQL endpoint for flexible queries across companies, people, investors, lists, and custom fields. Auth via apikey header or OAuth 2.0 bearer tokens.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 39 operations across 26 paths, and defines 155 schemas. It is described by OpenAPI 3.1.0, at version 0.0.1.

Requests are made against the base URL https://api.harmonic.ai/.

39 operations 26 paths 155 schemas 5 DELETE15 GET1 PATCH14 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.1.0

API Version

0.0.1

Base URL

https://api.harmonic.ai/

Resource Areas

Paths & Operations 39

Across 26 paths, the API surfaces 39 operations — 5 DELETE, 15 GET, 1 PATCH, 14 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

companies 39

GET

/companies

Batch Get Company By Id Or Urn

batch_get_company_by_id_or_urn_companies_get 4 params → 200422

POST

/companies

Get Company By Identifiers

get_company_by_identifiers_companies_post 16 params → 200422

POST

/companies/entries

Global Import Companies

global_import_companies_companies_entries_post body → 200422

GET

/companies/custom_fields

Get Global Custom Fields

get_global_custom_fields_companies_custom_fields_get → 200

POST

/companies/custom_field

Create Global Custom Field

create_global_custom_field_companies_custom_field_post body → 200422

PUT

/companies/custom_field

Update Global Custom Field

update_global_custom_field_companies_custom_field_put 1 param body → 200422

DELETE

/companies/custom_field

Delete Custom Field

delete_custom_field_companies_custom_field_delete 1 param → 200422

POST

/companies/batchGet

Batch Get Companies By Id Or Urn Using Post

batch_get_companies_by_id_or_urn_using_post_companies_batchGet_post 1 param body → 200422

GET

/companies/{id_or_urn}

Get Company By Id Or Urn

get_company_by_id_or_urn_companies__id_or_urn__get 3 params → 200422

GET

/companies/{id_or_urn}/employees

Get Employees

get_employees_companies__id_or_urn__employees_get 6 params → 200422

GET

/companies/{id_or_urn}/userConnections

Get User Connections

get_user_connections_companies__id_or_urn__userConnections_get 1 param → 200422

POST

/companies/attachments

Batch Get Attachments

batch_get_attachments_companies_attachments_post body → 200422

DELETE

/companies/attachments

Batch Delete Attachments

batch_delete_attachments_companies_attachments_delete body → 200422

POST

/companies/{id_or_urn}/attachments

Batch Create Attachments

batch_create_attachments_companies__id_or_urn__attachments_post 1 param body → 200422

PUT

/companies/{id_or_urn}/attachments

Batch Complete Upload

batch_complete_upload_companies__id_or_urn__attachments_put 1 param body → 200422

PATCH

/companies/{id_or_urn}/attachments

Link Attachments

link_attachments_companies__id_or_urn__attachments_patch 1 param body → 200422

GET

/companies/{id_or_urn}/attachments/{urn}

Get Attachment Content

get_attachment_content_companies__id_or_urn__attachments__urn__get 3 params → 200422

DELETE

/companies/{id_or_urn}/attachments/{urn}

Delete Attachment

delete_attachment_companies__id_or_urn__attachments__urn__delete 2 params → 200422

GET

/watchlists/companies

Get Company Watchlists By Owner

get_company_watchlists_by_owner_watchlists_companies_get 5 params → 200422

POST

/watchlists/companies

Create Company Watchlist

create_company_watchlist_watchlists_companies_post body → 200422

POST

/watchlists/companies/{id_or_urn}/custom_field

Create Company Watchlist Custom Field

create_company_watchlist_custom_field_watchlists_companies__id_or_urn__custom_field_post 1 param body → 200422

PUT

/watchlists/companies/{id_or_urn}/custom_field

Update Company Watchlist Custom Field

update_company_watchlist_custom_field_watchlists_companies__id_or_urn__custom_field_put 2 params body → 200422

DELETE

/watchlists/companies/{id_or_urn}/custom_field

Delete Company Watchlist Custom Field

delete_company_watchlist_custom_field_watchlists_companies__id_or_urn__custom_field_delete 1 param → 200422

GET

/watchlists/companies/{id_or_urn}/imports

Get Company Watchlist Imports

get_company_watchlist_imports_watchlists_companies__id_or_urn__imports_get 3 params → 200422

POST

/watchlists/companies/{id_or_urn}/named_views

Upsert Company Watchlist Named Views

upsert_company_watchlist_named_views_watchlists_companies__id_or_urn__named_views_post 2 params body → 200422

GET

/watchlists/companies/{id_or_urn}

Get Company Watchlist

get_company_watchlist_watchlists_companies__id_or_urn__get 6 params → 200422

PUT

/watchlists/companies/{id_or_urn}

Update Company Watchlist

update_company_watchlist_watchlists_companies__id_or_urn__put 1 param body → 200422

DELETE

/watchlists/companies/{id_or_urn}

Delete Company Watchlist

delete_company_watchlist_watchlists_companies__id_or_urn__delete 1 param → 200422

GET

/watchlists/companies/{id_or_urn}/entries

Get Company Watchlist Entries

get_company_watchlist_entries_watchlists_companies__id_or_urn__entries_get 8 params → 200422

POST

/watchlists/companies/{id_or_urn}/entries

Company Watchlist Add Entries

company_watchlist_add_entries_watchlists_companies__id_or_urn__entries_post 1 param body → 200422

POST

/watchlists/companies/{id_or_urn}:addCompanies

Add Companies To Company Watchlist

add_companies_to_company_watchlist_watchlists_companies__id_or_urn__addCompanies_post 1 param body → 200422

POST

/watchlists/companies/{id_or_urn}:removeCompanies

Remove Companies From Company Watchlist

remove_companies_from_company_watchlist_watchlists_companies__id_or_urn__removeCompanies_post 1 param body → 200422

POST

/watchlists/companies/{id_or_urn}/entries:batchDelete

Company Watchlist Batch Delete Entries

company_watchlist_batch_delete_entries_watchlists_companies__id_or_urn__entries_batchDelete_post 1 param body → 200422

GET

/watchlists/companies/imports/{id_or_urn}

Get User Company Import

get_user_company_import_watchlists_companies_imports__id_or_urn__get 1 param → 200422

GET

/watchlists/companies/imports/{id_or_urn}/entries

Get User Company Import Entries

get_user_company_import_entries_watchlists_companies_imports__id_or_urn__entries_get 4 params → 200422

POST

/search/companies_by_keywords

Search Companies By Keywords

search_companies_by_keywords_search_companies_by_keywords_post 2 params body → 200422

GET

/search/similar_companies/{id_or_urn}

Search Similar Companies

search_similar_companies_search_similar_companies__id_or_urn__get 2 params → 200422

GET

/search/typeahead

Typeahead Search

typeahead_search_search_typeahead_get 5 params → 200422

GET

/search/search_agent

Search Agent

search_agent_search_search_agent_get 4 params → 200422

Schemas 155

The contract defines 155 schemas that model the data the API accepts and returns. The most detailed are CompanyOutput (48 properties), TractionMetrics (31 properties), CompanySnapshotOutput (24 properties), UserCompaniesImportOutputWithStats (18 properties). Each schema is shown below with its type and property counts.

HTTPValidationError

object

1 property

NumberListCustomFieldValueFormat

string

CompanyListNamedViewUpsertInput

object

7 properties

ResourceUrnResponse_Union_CompanyWatchlistUrn__SynapseListUrn__

object

2 properties 1 required

CompanyListNamedViewColumnViewSettings

object

2 properties 1 required

SingleListSelectCustomFieldValue

object

1 property

NotableFollowerOutput

object

A tracked notable account (firm or individual investor) following a person at the company, or the company's own X handle.

7 properties 2 required

UserConnectionSource

string

CompanyWatchlistInput

object

4 properties 2 required

FilterGroupGeneratorId

string

CurrentlyRaisingEnum

string

CheckboxListCustomFieldValue

object

1 property

CompanyCanonicalParameter

object

4 properties

BatchCreateAttachmentsRequest

object

1 property 1 required

Sort-Output

object

3 properties 2 required

SearchOutput_PersonUrn_

object

3 properties 1 required

FundingMetadata-Output

object

9 properties

CompanyRelationship

object

6 properties

WebsiteMetadata

object

3 properties

CreateAttachmentRequest

object

3 properties 3 required

FacetModel

object

4 properties 3 required

CompanyHighlightCategory

string

NumberListCustomFieldValue

object

1 property

UpdateCompanyListCustomFieldInput

object

3 properties 1 required

CompaniesModel

object

Model representing company data for search and filtering. Extracted to avoid circular imports between savedsearch.py and facetparsingschemas.py

4 properties 3 required

SocialStatus

integer

AttachmentMetadataListOutput

object

1 property 1 required

services__midtier__schemas__common__Highlight-Output

object

4 properties 1 required

BatchCompanyAttachmentsRequest

object

1 property 1 required

DateListCustomFieldValueFormat

string

FundingRoundOutput

object

13 properties 4 required

SelectListCustomFieldValueOption

object

3 properties 2 required

SelectListCustomFieldMetadata

object

2 properties

CompanyWatchlistEntry

object

8 properties 5 required

StatusListCustomFieldValue

object

1 property

FounderProvidedAttachment

object

3 properties 1 required

EmployeeStatus

string

LocationMetadata

object

8 properties

UserWatchlistType

string

BatchCompanyAttachmentsOutput

object

2 properties 2 required

ValuationSource

string

Source classification for valuation data.

InvestorVisbility

string

DateListCustomFieldMetadata

object

1 property

TypeaheadSource

string

BatchCreateAttachmentsOutput

object

1 property 1 required

SearchAgentCursorSearchOutput

object

4 properties 2 required

RecordReferenceListCustomFieldValue

object

1 property

SortContextArguments

object

5 properties

UserImportedCompanyOutput

object

15 properties 5 required

PersonMetadata-Output

object

11 properties 1 required

RoleType

string

CompanyListEntriesBatchDeleteInput

object

1 property 1 required

SelectListCustomFieldValueOptionInputSchema

object

4 properties 2 required

PersonListCustomFieldValueMode

string

KeywordSearchInput

object

6 properties

CompanyBatchGetInput

object

3 properties

TypeaheadEntity

object

10 properties 3 required

CompanyValuationInfo-Output

object

Company-level valuation info - extends base with staleness fields.

5 properties

ImportCompaniesCanonicalsOutput

object

5 properties 5 required

TagType

string

FacebookSocialMetadata

object

6 properties

PersonHighlightCategory

string

CreateAttachmentOutput

object

8 properties 8 required

SelectListCustomFieldMetadataInputSchema

object

1 property

Subsidiary

object

1 property 1 required

TypeaheadSearchOutput

object

3 properties 1 required

ResourceUrnResponse_Union_CompanyListCustomFieldUrn__ListAttributeUrn__RecordAttributeUrn__

object

2 properties 1 required

FundingRoundInvestor

object

6 properties 3 required

FoundingDate-Output

object

2 properties 2 required

GetAttachmentContentResponse

object

1 property 1 required

DBOperationMetadata

object

4 properties

CompanyListEntriesBatchDeleteOutput

object

1 property

DateListCustomFieldDefaultValueMode

string

CompanyListEntryInput

object

6 properties

CurrentlyRaising

object

3 properties

ListNamedViewDisplayType

string

CompanyListCustomFieldValueOutput

object

6 properties 6 required

StealthEmergence

object

2 properties

CompanyFieldInputValue

object

2 properties 2 required

CompanyType

string

RecordReferenceListCustomFieldMetadata

object

3 properties 2 required

ContactMetadata

object

5 properties

SocialMetadata

object

4 properties

UserCompanyImportEntries

object

1 property 1 required

CompanyListCustomFieldOutput

object

8 properties 6 required

GetCompanyWatchlistEntriesOutput

object

3 properties

UserCompaniesImportsOutput

object

2 properties 2 required

BatchCompleteUploadRequest

object

1 property 1 required

WebsiteListCustomFieldValue

object

1 property

SearchType

string

MultiSelectListCustomFieldValue

object

1 property

SearchOutput_Union_CompanyUrn__CompanyOutput__

object

3 properties 1 required

SearchOutput_CompanyUrn_

object

3 properties 1 required

FoundingDatePrecision

string

FundingStage

string

IndexMethod

integer

ParsedQueryModel-Output

object

10 properties

TagOutput

object

6 properties 3 required

FundingType

string

Investor

object

2 properties

PersonListCustomFieldDefaultValue

object

2 properties 1 required

CompanyWatchlistUpdateInput

object

3 properties

CompanyListEntriesBatchImportInput

object

1 property 1 required

ValidationError

object

5 properties 3 required

Filter

object

4 properties 2 required

Body_add_companies_to_company_watchlist_watchlists_companies__id_or_urn__addCompanies_post

object

2 properties

TractionMetricsTimeSeriesMetric

object

2 properties 2 required

PersonListCustomFieldDefaultValueMode

string

LinkAttachmentsRequest

object

1 property 1 required

CompanyOutput

object

48 properties 2 required

UserConnectionExtendedOutput

object

8 properties 2 required

CompanyListNamedViewOutput

object

10 properties 7 required

ListImportType

string

ApiSearchQuery-Input

object

5 properties 2 required

FilterGroupGenerator

object

2 properties 2 required

CompanySnapshotOutput

object

24 properties 1 required

services__midtier__schemas__saved_search__Sort

object

3 properties 2 required

OwnershipStatus

string

CompanyWatchlistOutput

object

15 properties 7 required

FounderStory

object

3 properties

Department

string

TypeaheadSearchType

string

PersonSelectCustomFieldValueInput

object

1 property

BatchDeleteAttachmentsRequest

object

1 property 1 required

ApiSearchQuery-Output

object

5 properties 2 required

ValuationInfo

object

Base valuation info - used for per-funding-round valuation.

3 properties

FilterGroup-Input

object

4 properties 1 required

TypeaheadSubtype

string

SearchResult_CompanyUrn_

object

2 properties 1 required

FundingCompletionStatus

string

Attachments

object

3 properties

Pagination

object

2 properties 1 required

Body_remove_companies_from_company_watchlist_watchlists_companies__id_or_urn__removeCompanies_post

object

2 properties

PersonListCustomFieldMetadata

object

1 property 1 required

UserCompaniesImportOutputWithStats

object

18 properties 10 required

UnifiedExternalCompanyListEntryModel

object

10 properties 3 required

TextListCustomFieldValue

object

1 property

CreateCompanyListCustomFieldInput

object

4 properties 2 required

Acquisition

object

1 property 1 required

TractionMetricsPoint

object

3 properties

ResourceUrnResponse_CompanyListCustomFieldUrn_

object

2 properties 1 required

DateListCustomFieldDefaultValue

object

2 properties 1 required

PaginationMetadata

object

3 properties 1 required

DateListCustomFieldValue

object

1 property

NumberListCustomFieldMetadata

object

1 property

LimitedApiRequestModel-Output

object

2 properties

TractionMetricsInfo

object

7 properties 5 required

TractionMetrics

object

31 properties 23 required

UserConnectionStatus

string

PersonSelectCustomFieldValue

object

1 property

EmployeeGroupType

string

FilterGroup-Output

object

4 properties 1 required

ListCustomFieldType

string

FundingAttributeNullStatus

string

Describes how to interpret a null value for a funding attribute on a Company object. Affects the following Company fields: - numfundingrounds - numinvestors -…

AttachmentMetadataOutput

object

10 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#startup-intelligence#venture-capital#company-data#people-data#investor-data#funding-data#data-enrichment#sales-intelligence#market-intelligence#graphql#mcp#agent-native

← Back to H APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Harmonic REST & GraphQL API

Metadata

Paths & Operations 39

Schemas 155

Specification

Source

API Details

Provider

Explore more