DocumentationAPI ReferenceRelease Notes
API Reference

Get Sessions

Retrieves Sessions with optional filtering by status and User ID.

Required Permission(s)

Any of the following:

  • Administrators role
  • ISA role
  • Session Auditor role
  • Recorded Session Reviewer role
  • Active Session Reviewer role
  • Password Safe Admin Session Reviewer (Read)

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

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

User ID to filter Sessions by specific User

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.