Harmonic

App · 25 actions

Research companies and people, search similar companies, and manage company and people lists.

Actions

ActionWhat it does
Create company listCreate company list.
Create people listCreate people list.
Delete company listDelete company list.
Delete people listDelete people list.
Enrich companyEnrich company.
Enrich personEnrich person.
Get companiesGet companies.
Get companyGet company.
Get company employeesGet company employees.
Get company listGet company list.
Get company list entriesGet company list entries.
Get enrichment statusGet enrichment status.
Get peopleGet people.
Get people listGet people list.
Get people list entriesGet people list entries.
Get personGet person.
Get saved search new resultsGet saved search new results.
Get saved search resultsGet saved search results.
List company listsList company lists.
List people listsList people lists.
List saved searchesList saved searches.
Search namesSearch names.
Search similar companiesSearch similar companies.
Update company listUpdate company list.
Update people listUpdate people list.

Create company list

Create company list.

Inputs

NamenametextRequired
Name.
Shared with teamshared_with_teamtrue/falseRequired
Shared with team.
User watchlist typeuser_watchlist_typetext
User watchlist type.One of: USER_MANAGED_WATCHLIST (User managed watchlist), CUSTOMER_MANAGED_WATCHLIST (Customer managed watchlist), USER_FAVORITED_ENTITIES (User favorited entities), USER_HIDDEN_ENTITIES (User hidden entities), CUSTOMER_PORTFOLIO_LIST (Customer portfolio list), CUSTOMER_AFFINITY_SYNCED_LIST (Customer affinity synced list), CUSTOMER_ATTIO_SYNCED_LIST (Customer attio synced list), GLOBAL_FIELD_LIST (Global field list).
Companiescompanieslist
Companies.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "metadata": {
      "count_changed": 1,
      "count_not_found": 1,
      "count_skipped": 1,
      "count_total": 1
    },
    "urn": "example"
  }
}

Create people list

Create people list.

Inputs

NamenametextRequired
Name.
Shared with teamshared_with_teamtrue/falseRequired
Shared with team.
Peoplepeoplelist
People.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "metadata": {
      "count_changed": 1,
      "count_not_found": 1,
      "count_skipped": 1,
      "count_total": 1
    },
    "urn": "example"
  }
}

Delete company list

Delete company list.

Inputs

ID or URNid_or_urntextRequired
ID or URN.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "metadata": {
      "count_changed": 1,
      "count_not_found": 1,
      "count_skipped": 1,
      "count_total": 1
    },
    "urn": "example"
  }
}

Delete people list

Delete people list.

Inputs

ID or URNid_or_urntextRequired
ID or URN.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "metadata": {
      "count_changed": 1,
      "count_not_found": 1,
      "count_skipped": 1,
      "count_total": 1
    },
    "urn": "example"
  }
}

Enrich company

Enrich company.

Inputs

Linkedin urllinkedin_urltext
Company LinkedIn profile URL.
Website urlwebsite_urltext
Company website URL.
Twitter urltwitter_urltext
Company twitter URL.
Crunchbase urlcrunchbase_urltext
Company Crunchbase profile URL.
Pitchbook urlpitchbook_urltext
Company, Investor, or Advisor Pitchbook profile URL.
Instagram urlinstagram_urltext
Company Instagram profile URL.
Facebook urlfacebook_urltext
Company Facebook profile URL.
Angellist urlangellist_urltext
Company Angellist profile URL.
Monster urlmonster_urltext
Company Monster profile URL.
Indeed urlindeed_urltext
Company Indeed profile URL.
Stackoverflow urlstackoverflow_urltext
Company StackOverflow profile URL.
Glassdoor urlglassdoor_urltext
Company Glassdoor profile URL.
Website domainwebsite_domaintext
Company website domain.
Include fieldsinclude_fieldslist
Company fields to fetch.
Enrich missing companyenrich_missing_companytrue/false
Enrich missing company.Default: true.
Hide non surfaceable companyhide_non_surfaceable_companytrue/false
Hide non surfaceable company.Default: false.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "company_type": "UNKNOWN",
    "contact": {
      "emails": [],
      "exec_emails": [],
      "phone_numbers": [],
      "primary_email": "example",
      "primary_email_person_id": 1
    },
    "corrected_headcount": 1,
    "currently_raising": {
      "source": "example",
      "submitted_at": "example",
      "value": "YES"
    },
    "customer_type": "example",
    "description": "example",
    "employee_highlights": [],
    "enrichment_urn": "example",
    "entity_urn": "example",
    "external_description": "example",
    "external_headcount": 1,
    "founder_attachments": {
      "source": "example",
      "submitted_at": "example",
      "value": []
    },
    "founder_story": {
      "source": "example",
      "submitted_at": "example",
      "value": "example"
    },
    "founding_date": {
      "date": "example",
      "granularity": "DAY"
    },
    "funding": {
      "funding_stage": "STEALTH",
      "funding_total": 1.0,
      "investors": [],
      "last_funding_at": {},
      "last_funding_total": "example",
      "last_funding_type": "ACCELERATOR_INCUBATOR",
      "num_funding_rounds": 1,
      "valuation": 1,
      "valuation_info": {
        "is_potentially_stale": {},
        "is_potentially_stale_details": {},
        "source": {},
        "source_details": {},
        "value": {}
      }
    },
    "funding_attribute_null_status": "EXISTS_BUT_UNDISCLOSED",
    "funding_per_employee": 1.0,
    "funding_rounds": [],
    "headcount": 1,
    "headquarters": "example",
    "highlights": [],
    "id": 1,
    "initialized_date": "example",
    "investor_urn": "example",
    "leadership_prior_companies": [],
    "legal_name": "example",
    "location": {
      "address_formatted": "example",
      "city": "example",
      "country": "example",
      "location": "example",
      "metro_areas": [],
      "state": "example",
      "street": "example",
      "zip": "example"
    },
    "logo_url": "example",
    "name": "example",
    "name_aliases": [],
    "notable_followers": [],
    "num_notable_followers": 1,
    "ownership_status": "PRIVATE",
    "people": [],
    "redirect_urn": "example",
    "related_companies": {
      "acquired_by": {
        "company_urn": "example"
      },
      "acquisitions": [],
      "beta_notice": "example",
      "prior_stealth_association": {
        "emergence_date": {},
        "previously_known_as": []
      },
      "rebrands": {
        "formerly_known_as": []
      },
      "subsidiaries": [],
      "subsidiary_of": {
        "company_urn": "example"
      }
    },
    "requested_entity_urn": "example",
    "short_description": "example",
    "snapshots": [],
    "socials": {},
    "stage": "STEALTH",
    "stealth_emergence_date": "example",
    "tags": [],
    "tags_v2": [],
    "traction_metrics": {
      "corrected_headcount": {
        "14d_ago": {},
        "180d_ago": {},
        "30d_ago": {},
        "365d_ago": {},
        "90d_ago": {},
        "latest_metric_value": {},
        "metrics": []
      },
      "external_facebook_follower_count": {
        "14d_ago": {},
        "180d_ago": {},
        "30d_ago": {},
        "365d_ago": {},
        "90d_ago": {},
        "latest_metric_value": {},
        "metrics": []
      },
      "external_facebook_following_count": {
        "14d_ago": {},
        "180d_ago": {},
        "30d_ago": {},
        "365d_ago": {},
        "90d_ago": {},
        "latest_metric_value": {},
        "metrics": []
      },
      "external_facebook_like_count": {
        "14d_ago": {},
        "180d_ago": {},
        "30d_ago": {},
        "365d_ago": {},
        "90d_ago": {},
        "latest_metric_value": {},
        "metrics": []
      },
      "external_headcount": {
        "14d_ago": {},
        "180d_ago": {},
        "30d_ago": {},
        "365d_ago": {},
        "90d_ago": {},
        "latest_metric_value": {},
        "metrics": []
      },
      "external_instagram_follower_count": {
        "14d_ago": {},
        "180d_ago": {},
        "30d_ago": {},
        "365d_ago": {},
        "90d_ago": {},
        "latest_metric_value": {},
        "metrics": []
      },
      "external_linkedin_follower_count": {
        "14d_ago": {},
        "180d_ago": {},
        "30d_ago": {},
        "365d_ago": {},
        "90d_ago": {},
        "latest_metric_value": {},
        "metrics": []
      },
      "external_twitter_follower_count": {
        "14d_ago": {},
        "180d_ago": {},
        "30d_ago": {},
        "365d_ago": {},
        "90d_ago": {},
        "latest_metric_value": {},
        "metrics": []
      },
      "facebook_follower_count": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "facebook_following_count": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "facebook_like_count": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "funding_total": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_advisor": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_customer_success": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_data": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_design": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_engineering": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_finance": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_legal": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_marketing": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_operations": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_other": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_people": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_product": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_sales": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_support": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "instagram_follower_count": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "linkedin_follower_count": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "twitter_follower_count": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "web_traffic": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      }
    },
    "updated_at": "example",
    "web_traffic": 1,
    "website": {
      "domain": "example",
      "is_broken": false,
      "url": "example"
    },
    "website_domain_aliases": []
  }
}

Enrich person

Enrich person.

Inputs

Linkedin urllinkedin_urltext
Linkedin profile URL.
Emailemailtext
Email address for person lookup. Used as fallback when linkedin_url is not provided or yields no result.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "awards__beta": [],
    "contact": {
      "emails": [],
      "exec_emails": [],
      "phone_numbers": [],
      "primary_email": "example",
      "primary_email_person_id": 1
    },
    "current_company_urns": [],
    "education": [],
    "enrichment_urn": "example",
    "entity_urn": "example",
    "experience": [],
    "first_name": "example",
    "full_name": "example",
    "highlights": [],
    "id": "example",
    "investor_urn": "example",
    "is_redacted": false,
    "languages": [],
    "last_checked_at": "example",
    "last_name": "example",
    "last_refreshed_at": "example",
    "linkedin_connections": 1,
    "linkedin_headline": "example",
    "linkedin_profile_visibility_type": "FULLY_PUBLIC",
    "location": {
      "address_formatted": "example",
      "city": "example",
      "country": "example",
      "location": "example",
      "metro_areas": [],
      "state": "example",
      "street": "example",
      "zip": "example"
    },
    "merged_person_urn": "example",
    "notable_followers": [],
    "num_notable_followers": 1,
    "profile_picture_url": "example",
    "recommendations__beta": [],
    "requested_entity_urn": "example",
    "socials": {},
    "unstandardized_experience__internal": [],
    "updated_at": "example",
    "usurping_person_id": 1,
    "websites": []
  }
}

Get companies

Get companies.

Inputs

Idsidslist
Ids.
Urnsurnslist
Urns.
Extendedextendedtrue/false
Extended.Default: true.
Include fieldsinclude_fieldslist
Company fields to fetch.

Outputs

dataobject
Result.
Example output
{
  "data": {}
}

Get company

Get company.

Inputs

ID or URNid_or_urntextRequired
ID or URN.
Extendedextendedtrue/false
Extended.Default: true.
Include fieldsinclude_fieldslist
Include fields.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "company_type": "UNKNOWN",
    "contact": {
      "emails": [],
      "exec_emails": [],
      "phone_numbers": [],
      "primary_email": "example",
      "primary_email_person_id": 1
    },
    "corrected_headcount": 1,
    "currently_raising": {
      "source": "example",
      "submitted_at": "example",
      "value": "YES"
    },
    "customer_type": "example",
    "description": "example",
    "employee_highlights": [],
    "entity_urn": "example",
    "external_description": "example",
    "external_headcount": 1,
    "founder_attachments": {
      "source": "example",
      "submitted_at": "example",
      "value": []
    },
    "founder_story": {
      "source": "example",
      "submitted_at": "example",
      "value": "example"
    },
    "founding_date": {
      "date": "example",
      "granularity": "DAY"
    },
    "funding": {
      "funding_stage": "STEALTH",
      "funding_total": 1.0,
      "investors": [],
      "last_funding_at": {},
      "last_funding_total": "example",
      "last_funding_type": "ACCELERATOR_INCUBATOR",
      "num_funding_rounds": 1,
      "valuation": 1,
      "valuation_info": {
        "is_potentially_stale": false,
        "is_potentially_stale_details": "example",
        "source": {},
        "source_details": "example",
        "value": 1
      }
    },
    "funding_attribute_null_status": "EXISTS_BUT_UNDISCLOSED",
    "funding_per_employee": 1.0,
    "funding_rounds": [],
    "headcount": 1,
    "headquarters": "example",
    "highlights": [],
    "id": 1,
    "initialized_date": "example",
    "investor_urn": "example",
    "leadership_prior_companies": [],
    "legal_name": "example",
    "location": {
      "address_formatted": "example",
      "city": "example",
      "country": "example",
      "location": "example",
      "metro_areas": [],
      "state": "example",
      "street": "example",
      "zip": "example"
    },
    "logo_url": "example",
    "name": "example",
    "name_aliases": [],
    "notable_followers": [],
    "num_notable_followers": 1,
    "ownership_status": "PRIVATE",
    "people": [],
    "redirect_urn": "example",
    "related_companies": {
      "acquired_by": {
        "company_urn": "example"
      },
      "acquisitions": [],
      "beta_notice": "example",
      "prior_stealth_association": {
        "emergence_date": "example",
        "previously_known_as": []
      },
      "rebrands": {
        "formerly_known_as": []
      },
      "subsidiaries": [],
      "subsidiary_of": {
        "company_urn": "example"
      }
    },
    "requested_entity_urn": "example",
    "short_description": "example",
    "snapshots": [],
    "socials": {},
    "stage": "STEALTH",
    "stealth_emergence_date": "example",
    "tags": [],
    "tags_v2": [],
    "traction_metrics": {
      "corrected_headcount": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "external_facebook_follower_count": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "external_facebook_following_count": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "external_facebook_like_count": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "external_headcount": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "external_instagram_follower_count": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "external_linkedin_follower_count": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "external_twitter_follower_count": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "facebook_follower_count": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "facebook_following_count": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "facebook_like_count": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "funding_total": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_advisor": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_customer_success": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_data": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_design": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_engineering": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_finance": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_legal": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_marketing": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_operations": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_other": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_people": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_product": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_sales": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "headcount_support": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "instagram_follower_count": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "linkedin_follower_count": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "twitter_follower_count": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      },
      "web_traffic": {
        "14d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "180d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "30d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "365d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "90d_ago": {
          "change": {},
          "percent_change": {},
          "value": {}
        },
        "latest_metric_value": 1.0,
        "metrics": []
      }
    },
    "updated_at": "example",
    "web_traffic": 1,
    "website": {
      "domain": "example",
      "is_broken": false,
      "url": "example"
    },
    "website_domain_aliases": []
  }
}

Get company employees

Get company employees.

Inputs

ID or URNid_or_urntextRequired
ID or URN.
Employee group typeemployee_group_typetext
Employee group type.One of: CEO, FOUNDERS_AND_CEO (Founders and ceo), EXECUTIVES, FOUNDERS, LEADERSHIP, NON_LEADERSHIP (Non leadership), ALL, ADVISORS, NON_PARTNERS (Non partners). Default: ALL.
Employee statusemployee_statustext
Employee status.One of: ACTIVE, NOT_ACTIVE (Not active), ACTIVE_AND_NOT_ACTIVE (Active and not active). Default: ACTIVE.
User connection statususer_connection_statustext
User connection status.One of: USER_CONNECTION (User connection), TEAM_CONNECTION (Team connection), NO_CONNECTION (No connection).
Pagepagenumber
Page.Default: 0.
Sizesizenumber
Size.From 1 to 100. Default: 10.
Cursorcursortext
Cursor for pagination. Pass the `page_info.next` value of the previous response to fetch the next page; `page` is ignored when set.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "count": 1,
    "page_info": {
      "current": "example",
      "has_next": false,
      "next": "example"
    },
    "results": []
  }
}

Get company list

Get company list.

Inputs

ID or URNid_or_urntextRequired
ID or URN.
Pagepagenumber
Page numberAt least 0. Default: 0.
Sizesizenumber
Page sizeFrom 1 to 100. Default: 10.
Sort fieldsort_fieldtext
Sort fieldDefault: company_id.
Sort descendingsort_descendingtrue/false
Is sort order descendingDefault: false.
Include ids onlyinclude_ids_onlytrue/false
Include ids only.Default: false.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "companies": [],
    "companies_count": 1,
    "created_at": "example",
    "creator": "example",
    "custom_fields": [],
    "entity_urn": "example",
    "id": "example",
    "name": "example",
    "named_views": [],
    "named_views_order": [],
    "owner": "example",
    "shared_with_team": false,
    "updated_at": "example",
    "user_relevance_score_influence_type": "example",
    "user_watchlist_type": "USER_MANAGED_WATCHLIST"
  }
}

Get company list entries

Get company list entries.

Inputs

ID or URNid_or_urntextRequired
ID or URN.
Pagepagenumber
Page numberAt least 0.
Sizesizenumber
Page sizeFrom 1 to 100. Default: 10.
Sort fieldsort_fieldtext
Sort fieldDefault: company_id.
Sort descendingsort_descendingtrue/false
Is sort order descendingDefault: false.
Search querysearch_querytext
Search query
Cursorcursortext
After cursor
Sort custom field urnsort_custom_field_urntext
Sort by a built-in field URN, custom-field URN, or record/list attribute URN (e.g. urn:harmonic:company_field:company_name or urn:harmonic:record_attribute:company:name).

Outputs

dataobject
Result.
Example output
{
  "data": {
    "entries": [],
    "page_info": {
      "current": "example",
      "has_next": false,
      "next": "example"
    },
    "total_count": 1
  }
}

Get enrichment status

Get enrichment status.

Inputs

Idsidslist
Ids.
Urnsurnslist
Urns.

Outputs

datalist
Result.
Example output
{
  "data": []
}

Get people

Get people.

Inputs

Idsidslist
Ids.
Urnsurnslist
Urns.
Company context urnscompany_context_urnslist
Company context urns.

Outputs

datalist
Result.
Example output
{
  "data": []
}

Get people list

Get people list.

Inputs

ID or URNid_or_urntextRequired
ID or URN.
Return people urnsreturn_people_urnstrue/false
Return person urns in the responseDefault: true.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "created_at": "example",
    "creator": "example",
    "custom_fields": [],
    "entity_urn": "example",
    "id": "example",
    "name": "example",
    "named_views": [],
    "named_views_order": [],
    "owner": "example",
    "page_info": {
      "current": "example",
      "has_next": false,
      "next": "example"
    },
    "people": [],
    "people_count": 1,
    "shared_with_team": false,
    "updated_at": "example",
    "user_watchlist_type": "USER_MANAGED_WATCHLIST"
  }
}

Get people list entries

Get people list entries.

Inputs

ID or URNid_or_urntextRequired
ID or URN.
Pagepagenumber
Page numberAt least 0.
Sizesizenumber
Page sizeFrom 1 to 100. Default: 10.
Sort fieldsort_fieldtext
Sort fieldDefault: person_last_update_event_date.
Sort descendingsort_descendingtrue/false
Is sort order descendingDefault: false.
Search querysearch_querytext
Search query
Cursorcursortext
After cursor
Sort custom field urnsort_custom_field_urntext
Sort by a built-in field URN, custom-field URN, or record/list attribute URN (e.g. urn:harmonic:person_field:person_name or urn:harmonic:record_attribute:person:full_name).

Outputs

dataobject
Result.
Example output
{
  "data": {
    "entries": [],
    "page_info": {
      "current": "example",
      "has_next": false,
      "next": "example"
    },
    "total_count": 1
  }
}

Get person

Get person.

Inputs

ID or URNid_or_urntextRequired
ID or URN.
Company context urnscompany_context_urnslist
Company context urns.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "awards__beta": [],
    "contact": {
      "emails": [],
      "exec_emails": [],
      "phone_numbers": [],
      "primary_email": "example",
      "primary_email_person_id": 1
    },
    "current_company_urns": [],
    "education": [],
    "entity_urn": "example",
    "experience": [],
    "first_name": "example",
    "full_name": "example",
    "highlights": [],
    "id": "example",
    "investor_urn": "example",
    "is_redacted": false,
    "languages": [],
    "last_checked_at": "example",
    "last_name": "example",
    "last_refreshed_at": "example",
    "linkedin_connections": 1,
    "linkedin_headline": "example",
    "linkedin_profile_visibility_type": "FULLY_PUBLIC",
    "location": {
      "address_formatted": "example",
      "city": "example",
      "country": "example",
      "location": "example",
      "metro_areas": [],
      "state": "example",
      "street": "example",
      "zip": "example"
    },
    "notable_followers": [],
    "num_notable_followers": 1,
    "profile_picture_url": "example",
    "recommendations__beta": [],
    "requested_entity_urn": "example",
    "socials": {},
    "unstandardized_experience__internal": [],
    "updated_at": "example",
    "usurping_person_id": 1,
    "websites": []
  }
}

Get saved search new results

Get saved search new results.

Inputs

ID or URNid_or_urntextRequired
ID or URN.
Sizesizenumber
Page sizeFrom 1 to 100. Default: 10.
Cursorcursortext
Cursor0 for pagination
New results sincenew_results_sincedate and time
Filter results that are matches after this date(in UTC). Accepts date (YYYY-MM-DD) or datetime (YYYY-MM-DDTHH:00:00Z) formats. Examples: '2024-03-20' or '2024-03-20T14:00:00Z'. When specified, returns all matching results regardless of their cleared status.
Hydrate entitieshydrate_entitiestrue/false
Hydrate result URNs into entity objectsDefault: true.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "cursor": "example",
    "page_info": {
      "current": "example",
      "has_next": false,
      "next": "example"
    },
    "urns": []
  }
}

Get saved search results

Get saved search results.

Inputs

ID or URNid_or_urntextRequired
ID or URN.
Cursorcursortext
Cursor for pagination
Exclude snapshotsexclude_snapshotstrue/false
Deprecated. Snapshot data is no longer materialized; this flag is retained only for backwards compatibility and has no effect on the fetch path.Default: false.
Hydrate entitieshydrate_entitiestrue/false
Hydrate result URNs into entity objectsDefault: true.
Pagepagenumber
Page numberAt least 0.
Sizesizenumber
Page sizeFrom 1 to 100. Default: 10.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "count": 1,
    "page_info": {
      "current": "example",
      "has_next": false,
      "next": "example"
    },
    "results": []
  }
}

List company lists

List company lists.

Inputs

Company urnscompany_urnslist
Only show those watchlists that contains company urns
Watchlist typewatchlist_typetext
Fetch watchlists with specific type. If None is provided, it fetches allOne of: USER_MANAGED_WATCHLIST (User managed watchlist), CUSTOMER_MANAGED_WATCHLIST (Customer managed watchlist), USER_FAVORITED_ENTITIES (User favorited entities), USER_HIDDEN_ENTITIES (User hidden entities), CUSTOMER_PORTFOLIO_LIST (Customer portfolio list), CUSTOMER_AFFINITY_SYNCED_LIST (Customer affinity synced list), CUSTOMER_ATTIO_SYNCED_LIST (Customer attio synced list), GLOBAL_FIELD_LIST (Global field list).
Return company urnsreturn_company_urnstrue/false
Whether the endpoint should return the company ids associated with the watchlist or not.Default: true.
Return company countreturn_company_counttrue/false
Whether the endpoint should return the number of companies associated with the watchlist or not.Default: true.
Get team shared listget_team_shared_listtrue/false
Fetch public watchlists shared by other users in the teamDefault: true.

Outputs

datalist
Result.
Example output
{
  "data": []
}

List people lists

List people lists.

Inputs

Person urnsperson_urnslist
Only show those watchlists that contains person urns
Return people urnsreturn_people_urnstrue/false
Return person urns in the responseDefault: true.
Return people countreturn_people_counttrue/false
Return person count in the responseDefault: true.
Watchlist typeswatchlist_typeslist
Filter watchlists by specific types. If empty, fetches all owner-accessible watchlists.One or more of: USER_MANAGED_WATCHLIST (User managed watchlist), CUSTOMER_MANAGED_WATCHLIST (Customer managed watchlist), USER_CONNECTIONS (User connections), TEAM_CONNECTIONS (Team connections), GLOBAL_FIELD_LIST (Global field list).

Outputs

datalist
Result.
Example output
{
  "data": []
}

List saved searches

List saved searches.

Inputs

None.

Outputs

datalist
Result.
Example output
{
  "data": []
}

Search names

Search names.

Inputs

QueryquerytextRequired
Query.
Search typesearch_typetext
Search type.One of: PERSON, COMPANY, SCHOOL, EMAIL_INTEGRATED_USER (Email integrated user), INVESTOR, INVESTOR_COMPANY (Investor company), INVESTOR_PERSON (Investor person), LOCATION, LOCATION_CITY (Location city), LOCATION_STATE (Location state), LOCATION_COUNTRY (Location country), LOCATION_METRO_AREA (Location metro area).
Sourcesourcetext
Source.One of: ENTERPRISE_APP (Enterprise app).
Pagepagenumber
Page numberAt least 0. Default: 0.
Sizesizenumber
Page sizeFrom 1 to 100. Default: 10.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "count": 1,
    "results": [],
    "total_count": 1
  }
}

Search similar companies

Search similar companies.

Inputs

ID or URNid_or_urntextRequired
ID or URN.
Sizesizenumber
Number of similar companies to fetchFrom 1 to 100. Default: 10.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "count": 1,
    "page_info": {
      "current": "example",
      "has_next": false,
      "next": "example"
    },
    "results": []
  }
}

Update company list

Update company list.

Inputs

ID or URNid_or_urntextRequired
ID or URN.
Namenametext
Name.
Shared with teamshared_with_teamtrue/false
Shared with team.
Named views ordernamed_views_orderlist
Named views order.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "metadata": {
      "count_changed": 1,
      "count_not_found": 1,
      "count_skipped": 1,
      "count_total": 1
    },
    "urn": "example"
  }
}

Update people list

Update people list.

Inputs

ID or URNid_or_urntextRequired
ID or URN.
Namenametext
Name.
Shared with teamshared_with_teamtrue/false
Shared with team.
Named views ordernamed_views_orderlist
Named views order.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "metadata": {
      "count_changed": 1,
      "count_not_found": 1,
      "count_skipped": 1,
      "count_total": 1
    },
    "urn": "example"
  }
}

On this page