HIPE icon

HIPE

Interact with HIPE API

company → Get Many

AI-generated

Summary

Retrieve multiple company records from the HIPE API, optionally filtered, sorted, and paginated.

Inputs

  • Return All — Boolean flag to indicate if all results should be returned regardless of limit.
  • Limit — Maximum number of company records to return when Return All is false; minimum 1, default 50.
  • Page — Page number to fetch, starting at 1; effective only when Return All is false.
  • Filters — Collection of filtering criteria including category, comment, company name, contact, creation date, status, type, and various other flat filter keys aligned with the OpenAPI specification.
  • Sort — Sorting option specifying the field to sort by (Name, Created At, Updated At) and the sort order (Ascending or Descending). Converted into a single query parameter forming 'field,ASC|DESC' format.

Output shape

A list of company records matching the specified filter and sorting criteria, limited by pagination settings or returning all if selected.

The results support pagination via 'Page' and 'Limit' when 'Return All' is false. When 'Return All' is true, all matching company records are returned without limit considerations. Filters are flat key-value pairs per OpenAPI filtering schema. Sort is converted internally to a query parameter as 'field,ASC|DESC'. Errors are returned in case of API failure.

Links

Discussion