HIPE icon

HIPE

Interact with HIPE API

job → Get Many

AI-generated

Summary

Retrieve multiple job records with optional filtering, sorting, and pagination.

Inputs

  • Return All — Boolean flag to decide whether to return all matching job records or only a limited page of results.
  • Limit — Maximum number of job records to return when 'Return All' is false.
  • Page — Page number to fetch when paginating results (starting at 1).
  • Filters — Optional filters to narrow down jobs based on Entity Type, External ID, Status, Sub Type, and Type.
  • Sort — Optional sorting options to order results by Created At, Updated At, Status, or Completeness, with ascending or descending order.

Output shape

a list of job records matching the specified filters, sorted and paginated as requested

If 'Return All' is true, all matching jobs are returned without pagination. Otherwise, results are limited and paginated by 'Limit' and 'Page' parameters. Returned data includes job details as provided by the HIPE API.

Links

Discussion