HIPE icon

HIPE

Interact with HIPE API

order → Get Many

AI-generated

Summary

Retrieve multiple orders with optional filtering, sorting, pagination, and control over the number of results returned.

Inputs

  • Return All — Choose whether to fetch all matching orders or limit the result set.
  • Limit — Specify the maximum number of orders to return when not returning all.
  • Page — Specify which page of results to retrieve (starting at 1), applicable when not returning all.
  • Filters — Apply filtering criteria to narrow down orders by Company ID, Created By, External ID, Project ID, Search term, or Status ID.
  • Sort — Define a single sort parameter by selecting a field (e.g., Created At, Order Date) and sort order (Ascending or Descending).

Output shape

a list of order records matching the specified filters, limited and sorted according to input parameters

Supports pagination with 'Page' and 'Limit' when 'Return All' is false; otherwise returns all matching orders. Filters and sorting are applied as query parameters to the fetching API. Returned data includes order details.

Links

Discussion