HIPE icon

HIPE

Interact with HIPE API

user → Search

AI-generated

Summary

Searches for users matching a specified URI-encoded JSON filter query and returns up to a specified limit of matching user records.

Inputs

  • Query (S) (required) — A URI-encoded JSON filter that defines criteria to match users. For example, s={"name":{"$contL":"john"}} searches for users whose name contains 'john' (case-insensitive).
  • Limit — Maximum number of user records to return. Defaults to 50 if not specified.

Output shape

a list of user records matching the given filter query, limited to the specified maximum number of results

The query parameter must be URI-encoded JSON. The limit parameter has a minimum value of 1. The operation returns an array of user data matching the filter, up to the limit count.

Links

Discussion