POST/v2/live/vendorgraphics/company/relationships

Company relationships

Returns a company's vendorgraphic relationships using cursor-based pagination (up to 500 per page). Supports an optional lastSeenAfter filter to return only relationships observed after a given time.

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

Request body

  • companyIdinteger (int64)Required
    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 whose relationships are returned
    • aggkCompanyIdinteger (int64)
      AggKnowledge company ID
    • linkedinUrlstring
      LinkedIn URL
    • namestring
      Company name
    • websitestring
      Company website
  • 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[]Required
    List of company relationships

Status codes