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
}
'import requests
url = "https://pria.praxislxp.com/api/admin/users"
payload = {
"account": "<string>",
"institution": "<string>",
"usersearch": "<string>",
"activeOnly": False,
"page": 1,
"pageSize": 100,
"limitsearch": 123
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
account: '<string>',
institution: '<string>',
usersearch: '<string>',
activeOnly: false,
page: 1,
pageSize: 100,
limitsearch: 123
})
};
fetch('https://pria.praxislxp.com/api/admin/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://pria.praxislxp.com/api/admin/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'account' => '<string>',
'institution' => '<string>',
'usersearch' => '<string>',
'activeOnly' => false,
'page' => 1,
'pageSize' => 100,
'limitsearch' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://pria.praxislxp.com/api/admin/users"
payload := strings.NewReader("{\n \"account\": \"<string>\",\n \"institution\": \"<string>\",\n \"usersearch\": \"<string>\",\n \"activeOnly\": false,\n \"page\": 1,\n \"pageSize\": 100,\n \"limitsearch\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://pria.praxislxp.com/api/admin/users")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"account\": \"<string>\",\n \"institution\": \"<string>\",\n \"usersearch\": \"<string>\",\n \"activeOnly\": false,\n \"page\": 1,\n \"pageSize\": 100,\n \"limitsearch\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/admin/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account\": \"<string>\",\n \"institution\": \"<string>\",\n \"usersearch\": \"<string>\",\n \"activeOnly\": false,\n \"page\": 1,\n \"pageSize\": 100,\n \"limitsearch\": 123\n}"
response = http.request(request)
puts response.read_body{
"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",
"creditCaps": {
"enabled": false,
"perUserAccountTotal": 123,
"perUserInstitutionDefault": 123,
"perUser24hDefault": 123
}
},
"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,
"displayRagSearchDetails": 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>"
}Search and retrieve users for admin management
Retrieves a list of users based on search criteria including institution, account type, and search terms
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
}
'import requests
url = "https://pria.praxislxp.com/api/admin/users"
payload = {
"account": "<string>",
"institution": "<string>",
"usersearch": "<string>",
"activeOnly": False,
"page": 1,
"pageSize": 100,
"limitsearch": 123
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
account: '<string>',
institution: '<string>',
usersearch: '<string>',
activeOnly: false,
page: 1,
pageSize: 100,
limitsearch: 123
})
};
fetch('https://pria.praxislxp.com/api/admin/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://pria.praxislxp.com/api/admin/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'account' => '<string>',
'institution' => '<string>',
'usersearch' => '<string>',
'activeOnly' => false,
'page' => 1,
'pageSize' => 100,
'limitsearch' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://pria.praxislxp.com/api/admin/users"
payload := strings.NewReader("{\n \"account\": \"<string>\",\n \"institution\": \"<string>\",\n \"usersearch\": \"<string>\",\n \"activeOnly\": false,\n \"page\": 1,\n \"pageSize\": 100,\n \"limitsearch\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://pria.praxislxp.com/api/admin/users")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"account\": \"<string>\",\n \"institution\": \"<string>\",\n \"usersearch\": \"<string>\",\n \"activeOnly\": false,\n \"page\": 1,\n \"pageSize\": 100,\n \"limitsearch\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/admin/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account\": \"<string>\",\n \"institution\": \"<string>\",\n \"usersearch\": \"<string>\",\n \"activeOnly\": false,\n \"page\": 1,\n \"pageSize\": 100,\n \"limitsearch\": 123\n}"
response = http.request(request)
puts response.read_body{
"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",
"creditCaps": {
"enabled": false,
"perUserAccountTotal": 123,
"perUserInstitutionDefault": 123,
"perUser24hDefault": 123
}
},
"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,
"displayRagSearchDetails": 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>"
}Authorizations
JWT token passed in x-access-token header
Body
Account ID(s) to filter users (space-separated for multiple)
Institution ID to filter users
Account type filter (user, admin, super)
user, admin, super Search term for users (matches email, first name, last name)
When true, restrict to users that have actually been used (lastActivityAt is set, not null).
Page number (1-based)
x >= 1Number of results per page
1 <= x <= 5000DEPRECATED: Use pageSize instead. Maximum number of results to return
Response
Successfully retrieved user list
Request success status
Array of user objects
Show child attributes
Show child attributes
Total number of matching users
Whether more results are available beyond the current page
Current page number
Number of results per page
Response message
Was this page helpful?