GET
Search Users by Name, Email, or Username

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

search
string | null

Keyword to search user directory across username, name, or email. Non-admin callers require at least 3 characters.

Example:

"ahmad"

q
string | null

Alias for the search parameter.

Example:

"ahmad"

limit
integer
default:50

Maximum number of records to return in the paginated response (1 to 100).

Required range: x <= 200
Example:

20

offset
integer
default:0

Number of initial records to skip for pagination.

Example:

0

unscoped
boolean
default:false

Bypass active role group scoping. Restricted to elevated roles (Level 1, 2, 99). Returns 403 Forbidden for low-privilege callers.

Response

List of matching users