Search user

Search users by keyword. The keyword is matched (case-insensitive, partial) against the user ID/email in the database and against display name, contact email and login ID.

  • Without page and per_page at most 10 database matches plus 10 profile matches are returned and page_info contains empty strings.
  • With both parameters the result is paginated.
  • LDAP-imported users are no longer searched separately (v13).
  • Since v13.0.28 every user contains social_auth (linked external identities).

Permission: System admin (is_staff) whose admin role grants can_manage_user. Admin roles with a restricted permission set (e.g. audit_admin, system_admin) receive 403.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

keyword for searching

integer

Page number. Pagination is only applied if page and per_page are both given.

integer

Results per page. Pagination is only applied if page and per_page are both given.

Responses

400

query invalid. (empty keyword).

403

Permission denied: the account is not a system admin, or its admin role lacks the required admin permission.

Language
Credentials
Bearer
Account-Token
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json