DocumentationAPI ReferenceRelease Notes
API Reference

Get users

Get users with optional filtering by username or activity status.

Required Permission(s)

  • User Accounts Management (Read)

Notes

  • Some usernames may be in the format hostname\username, if not represented by an email address.
  • Use of the optional query parameters results in the supplied value being recorded in the web server log file.
  • ClientSecret has no value; it can only be retrieved via API by initial creation or recycling it.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Optional username filter to retrieve a specific user

boolean
Defaults to false

Whether to include inactive users in the results

Responses

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

©2003-2026 BeyondTrust Corporation. All Rights Reserved. Other trademarks identified on this page are owned by their respective owners. BeyondTrust is not a chartered bank or trust company, or depository institution. It is not authorized to accept deposits or trust accounts and is not licensed or regulated by any state or federal banking authority.