POST/v3/live/company-relationships/customers

Customer company relationships

Returns company relationships where the requested company is the customer

Version
v3
Rate limit
Tier 3 · 10–200 rps by plan
Billing
Company Relationships · Customer company relationships

Request body

  • companyIdstringRequired
    Company ID to fetch relationships for
  • cursorstringOptional
    Cursor for pagination. Use the cursor value from the previous response to get more results. Important: When using pagination with filters (like lastSeenAfter), you must include the same filter parameters in subsequent requests along with the cursor.
  • lastSeenAfterstringOptional
    Filter relationships by last_seen_at date. Returns only relationships where last_seen_at is on or after this date. Accepts YYYY, YYYY-MM, or YYYY-MM-DD format. Note: This filter must be included in all paginated requests (along with the cursor) to maintain consistent results.
  • metadataobjectOptional
    Optional metadata to associate with the request. Will be returned in the response.
Headers
x-api-key Required · API key for authentication

Response

  • companyobject
    The company for which relationships are being fetched
    • companyTypeenum CompanyType
      Type of company
    • descriptionstring
      Brief description of the company
    • displayNamestring
      Company display name
    • employeeCountActualinteger (int32)
      Actual number of employees
    • employeeCountRangeenum CompanySize
      Bucketed number of employees
    • fundingRoundCountinteger (int32)
      Number of funding rounds the company has participated in
    • fundingTotalstring
      Total amount of funding raised and publicly disclosed, in USD
    • industryobject
    • isStructuredEntityboolean
      Whether this entity could be matched to a known company
    • latestFundingAmountstring
      Amount of latest funding round, if known
    • latestFundingDatestring
      Latest funding date
    • latestFundingStageenum FundingStage
      Stage of the company's latest funding round
    • socialProfileIdinteger (int64)
      Company social profile ID. Absent when the company has no social profile on file.
    • socialProfilestring
      Normalized company social profile URL. Absent when the company has none on file.
    • namestring
      Normalized company name
    • primaryExchangestring
      Primary stock exchange
    • primaryTickerstring
      Primary stock ticker
    • websitestring
      Normalized company website
    • cleanedWebsitestring
      Company website without its scheme, leading www., query string or trailing slash. Keeps any subdomain and path.
    • cleanedDomainstring
      Host of the company website, without a leading www. or any path
    • rootDomainstring
      Registrable domain of the company website under the Public Suffix List, e.g. example.co.uk for shop.example.co.uk
    • aggkCompanyIdstring
      Company ID
    • descriptionMetaobject
    • employeeGrowthobject
    • locationobject
    • revenueobject
    • tagsstring[]
      Tags associated with the company
  • cursorstring
    Cursor for pagination. Use this value as the cursor parameter in the next request to get more results.
  • hasProblemsboolean
    Whether we hit a problem answering the request: the profile or company wasn't found, or a data source failed or timed out. Data may be missing or incomplete; problems, where the response has it, says which.
  • isRetryableboolean
    When isSuccess is false, whether sending the same input again could succeed. Always true when isSuccess is true.
  • isSuccessboolean
    true when the request was answered with a result. false means no result was returned: check isRetryable, which is true when a data source failed or timed out and false when the input matched nothing.
  • metadataobject
    Caller-supplied metadata echoed back from the request.
  • relationshipsobject[]
    List of company relationships

Status codes