DocumentationAPI ReferenceRelease Notes
API Reference

Get all sessions

get
https://example.com/beyondtrust/api/public/v3/sessions

Retrieves all active sessions with optional filtering by status and user ID.

Required Permission(s)

Any of the following:

  • Session Auditor role to at least one asset Smart Rule
  • ISA role
  • Administrators role
  • Built-in Admin role

Notes

  • The maximum number of sessions returned is 100,000.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Optional - Session status - A single value or comma-delimited list of values:

  • 0: Not Started
  • 1: In Progress
  • 2: Completed
  • 5: Locked
  • 7: Terminated (deprecated)
  • 8: Logged Off
  • 9: Disconnected (RDP only)
int32

Optional user ID to filter sessions by specific user

Responses

Updated 9 months ago

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

Updated 9 months ago

©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.