Skip to main content
POST
/
api
/
admin
/
accounts
Search and retrieve accounts
curl --request POST \
  --url https://pria.praxislxp.com/api/admin/accounts \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "accountsearch": "<string>",
  "minimum": true,
  "insitutionsUsage": true,
  "page": 1,
  "pageSize": 50
}
'
{
  "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
​
accountsearch
string

Case-insensitive search term matched against account name and managerEmail (regex-escaped)

​
minimum
boolean

Whether to return minimal account data (bypasses pagination)

​
insitutionsUsage
boolean

When true, includes an institutionsUsage summary (count, credits, creditsUsed, creditsTotal, creditsUsagePct) aggregated across the account's institutions

​
page
integer
default:1

Page number (1-based)

Required range: x >= 1
​
pageSize
integer
default:50

Number of results per page

Required range: 1 <= x <= 5000

Response

Successfully retrieved account list

​
success
boolean

Request success status

​
data
object[]

Array of account objects

​
total
integer

Total number of matching accounts

​
hasMore
boolean

Whether more results are available

​
page
integer

Current page number

​
pageSize
integer

Number of results per page

​
message
string

Response message