POST/v2/live/company/descriptions

Fetch company descriptions

Accepts an array of AggK Company IDs and returns descriptions. If a description is not found and the company is ineligible for descriptions, an error flag is set. Accepts up to 500 company IDs per request.

Version
v2
Rate limit
Tier 4 · 10–500 rps by plan
Billing
Company Enrichment · Fetch company descriptions

Request body

  • companyIdsinteger (int64)[]Required
    List of AggK Company IDs to fetch descriptions for (max 500)
    6573153315017574
    Enter adds a value · Backspace on empty removes the last
Headers
x-api-key Required · API key for authentication

Response

  • descriptionsobject[]
    List of company descriptions
    • aggkCompanyIdinteger (int64)Required
      AggK Company ID
    • descriptionstring
      Company description if available
    • isCompanyNotFoundboolean
      Set to true if the company was not found in the database
    • wasDescriptionRejectedboolean
      Whether the description for this company was rejected/blocked
    • willDescriptionBeGeneratedboolean
      Whether a description will be generated for this company in the future
  • 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.
  • 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.

Status codes