Skip to main content
POST
/
api
/
admin
/
sessions
Search and retrieve active sessions
curl --request POST \
  --url https://pria.praxislxp.com/api/admin/sessions \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "account": "<string>",
  "institution": "<string>",
  "usersearch": "<string>",
  "daterange": [
    "2023-11-07T05:31:56Z"
  ],
  "page": 1,
  "pageSize": 100,
  "limitsearch": 123
}
'
{
  "success": true,
  "data": [
    {}
  ],
  "total": 123,
  "hasMore": true,
  "page": 123,
  "pageSize": 123,
  "message": "<string>"
}

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
account
string

Account ID(s) to filter sessions (space-separated for multiple)

institution
string

Institution ID to filter sessions

usersearch
string

Search term for users (matches email, first name, last name)

daterange
(string<date-time> | null)[]

[startDate, endDate] — defaults to last 30 days if not provided

page
integer
default:1

Page number (1-based)

Required range: x >= 1
pageSize
integer
default:100

Number of results per page

Required range: 1 <= x <= 5000
limitsearch
number
deprecated

DEPRECATED: Use pageSize instead

Response

Successfully retrieved session list

success
boolean

Request success status

data
object[]

Array of session objects

total
integer

Total number of matching sessions

hasMore
boolean

Whether more results are available

page
integer

Current page number

pageSize
integer

Number of results per page

message
string

Response message