HIPE icon

HIPE

Interact with HIPE API

user → Get Many

AI-generated

Summary

Retrieve multiple user records from the HIPE system with optional filtering, sorting, and pagination.

Inputs

  • Return All — Choose whether to retrieve all user records or limit the number returned.
  • Limit — Specify the maximum number of user records to return when Return All is false (minimum 1, default 50).
  • Page — Specify which page of user records to retrieve, starting at 1, when Return All is false (default 1).
  • Filters — Optionally filter results by Client ID, saved Filter ID, user Name, Role (one or multiple roles), or a general search string.
  • Sort — Optionally specify sorting criteria: field to sort by (Name, Created At, Updated At, Status) and sort order (ascending or descending).

Output shape

a list of user records matching the filter criteria and pagination settings

If Return All is true, all matching users are returned ignoring Limit and Page; otherwise, results are paginated by Limit and Page parameters. The response includes user details filtered and sorted as specified. Results might be empty if no users match the filters.

Links

Discussion