Skip to main content
POST
/
api
/
admin
/
users
Search and retrieve users for admin management
curl --request POST \
  --url https://pria.praxislxp.com/api/admin/users \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "account": "<string>",
  "institution": "<string>",
  "usersearch": "<string>",
  "activeOnly": false,
  "page": 1,
  "pageSize": 100,
  "limitsearch": 123
}
'
{
  "success": true,
  "data": [
    {
      "_id": "<string>",
      "email": "jsmith@example.com",
      "fname": "<string>",
      "lname": "<string>",
      "accountType": "<string>",
      "status": "<string>",
      "lxp_user_id": "<string>",
      "picture": "<string>",
      "lxp_user_type": 123,
      "lxp_partner_id": 123,
      "lxp_partner_name": "<string>",
      "lxp_role_id": 123,
      "lxp_role_name": "<string>",
      "credits": 123,
      "creditsUsed": 123,
      "plan": "<string>",
      "institution": {
        "_id": "<string>",
        "name": "<string>",
        "picture": "<string>",
        "credits": 123,
        "creditsUsed": 123,
        "creditsAwarded": 123,
        "publicId": "<string>",
        "publicAuthorizedUrls": [
          "<string>"
        ],
        "ainame": "<string>",
        "contactEmail": "<string>",
        "poolCredits": true,
        "created": "2023-11-07T05:31:56Z",
        "lastActivityAt": "2023-11-07T05:31:56Z",
        "conversationModel": "<string>",
        "account": {
          "_id": "<string>",
          "name": "<string>",
          "managerEmail": "jsmith@example.com",
          "credits": 123,
          "domainUrls": [
            "<string>"
          ],
          "qualification": "<string>",
          "created": "2023-11-07T05:31:56Z"
        },
        "agent": {
          "enabled": true,
          "preset": "<string>",
          "manifestYaml": "<string>",
          "manifestDigest": "<string>",
          "preferences": {
            "cpu": 2.125,
            "memoryMb": 4352,
            "storageGb": 52,
            "gui": true,
            "vncResolution": "1280x800"
          },
          "requestedBy": "<string>",
          "requestedAt": "2023-11-07T05:31:56Z",
          "provisionedAt": "2023-11-07T05:31:56Z",
          "lastError": "<string>"
        },
        "maxCompletionTokens": 123,
        "creditsTotal": 123,
        "creditsUsagePct": 123,
        "id": "<string>",
        "displayAgentDetails": true,
        "displayThinkingDetails": true,
        "displayThinkingExecution": true,
        "displayToolExecution": true
      },
      "remember_history_count": 123,
      "created": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "hasMore": true,
  "page": 123,
  "pageSize": 123,
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.praxis-ai.com/llms.txt

Use this file to discover all available pages before exploring further.

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 users (space-separated for multiple)

​
institution
string

Institution ID to filter users

​
accountType
enum<string>

Account type filter (user, admin, super)

Available options:
user,
admin,
super
​
usersearch
string

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

​
activeOnly
boolean
default:false

When true, restrict to users that have actually been used (lastActivityAt is set, not null).

​
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. Maximum number of results to return

Response

Successfully retrieved user list

​
success
boolean

Request success status

​
data
object[]

Array of user objects

​
total
integer

Total number of matching users

​
hasMore
boolean

Whether more results are available beyond the current page

​
page
integer

Current page number

​
pageSize
integer

Number of results per page

​
message
string

Response message