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 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "institution": "<string>",
  "accountType": "<string>",
  "usersearch": "<string>",
  "limitsearch": 123
}'
{
  "success": true,
  "data": [
    {
      "_id": "<string>",
      "email": "jsmith@example.com",
      "fname": "<string>",
      "lname": "<string>",
      "accountType": "<string>",
      "lxp_user_id": 123,
      "picture": "<string>",
      "status": "<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,
        "status": "active",
        "publicId": "<string>",
        "publicAuthorizedUrls": [
          "<string>"
        ],
        "ainame": "<string>",
        "contactEmail": "<string>",
        "poolCredits": true,
        "created": "2023-11-07T05:31:56Z",
        "conversationModel": "<string>",
        "account": {
          "_id": "<string>",
          "name": "<string>"
        },
        "maxCompletionTokens": 123,
        "creditsTotal": 123,
        "creditsUsagePct": 123,
        "id": "<string>",
        "displayAgentDetails": true
      },
      "remember_history_count": 123,
      "created": "2023-11-07T05:31:56Z"
    }
  ],
  "message": "<string>"
}

Authorizations

Authorization
string
header
required

JWT token passed in x-access-token header

Body

application/json
institution
string

Institution ID to filter users

accountType
string

Account type filter

usersearch
string

Search term for users

limitsearch
number

Maximum number of results to return

Response

Successfully retrieved user list

success
boolean

Request success status

data
object[]

Array of user objects

message
string

Response message