Dec 2025 - New! Caching input tokens unlocks immediate, automatic ~30% credit savings on supported models
curl --request POST \
--url http://localhost:3000/api/admin/userInstitutions \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"institution": "65cfebc32f5e1b37d4e52329",
"accountType": "user",
"usersearch": "praxis",
"limitsearch": 100,
"emptyInstitutions": false
}
'{
"success": true,
"data": [
{
"lastConversation": {
"course_id": 123,
"course_name": "<string>"
},
"digitaltwin": true,
"_id": "<string>",
"user": {
"_id": "<string>",
"email": "[email protected]",
"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"
},
"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
},
"entitlements": [
"<string>"
],
"accountType": "<string>",
"status": "<string>",
"creditAwarded": 123,
"created": "2023-11-07T05:31:56Z",
"lastLogin": "2023-11-07T05:31:56Z",
"lastKA": "2023-11-07T05:31:56Z"
}
]
}Retrieves a list of users and their relationships with institutions based on search criteria
curl --request POST \
--url http://localhost:3000/api/admin/userInstitutions \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"institution": "65cfebc32f5e1b37d4e52329",
"accountType": "user",
"usersearch": "praxis",
"limitsearch": 100,
"emptyInstitutions": false
}
'{
"success": true,
"data": [
{
"lastConversation": {
"course_id": 123,
"course_name": "<string>"
},
"digitaltwin": true,
"_id": "<string>",
"user": {
"_id": "<string>",
"email": "[email protected]",
"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"
},
"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
},
"entitlements": [
"<string>"
],
"accountType": "<string>",
"status": "<string>",
"creditAwarded": 123,
"created": "2023-11-07T05:31:56Z",
"lastLogin": "2023-11-07T05:31:56Z",
"lastKA": "2023-11-07T05:31:56Z"
}
]
}JWT token passed in x-access-token header
Institution ID
"65cfebc32f5e1b37d4e52329"
Type of account to filter by
"user"
Search term for filtering users
"praxis"
Maximum number of results to return
100
Whether to include empty institutions
false
Successfully retrieved user institution data
Whether the request was successful
Array of user institution relationships
Show child attributes
Whether digital twin is enabled
User institution relationship ID
Show child attributes
User ID
User email address
User first name
User last name
User account type
LXP user identifier
Profile picture URL
User status
LXP user type
LXP partner identifier
LXP partner name
LXP role identifier
LXP role name
Available credits
Credits used
Subscription plan
Show child attributes
Institution ID
Institution name
Institution picture URL
Available credits for the institution
Number of credits used
Credits awarded to the institution
Institution status
active, inactive Public identifier for the institution
List of authorized URLs for the institution
AI name for the institution
Contact email for the institution
Whether credits are pooled
Institution creation timestamp
AI conversation model used
Maximum completion tokens allowed
Total credits available
Percentage of credits used
Institution identifier
Whether to display agent details
History count setting
Creation timestamp
Show child attributes
Institution ID
Institution name
Institution picture URL
Available credits for the institution
Number of credits used
Credits awarded to the institution
Institution status
active, inactive Public identifier for the institution
List of authorized URLs for the institution
AI name for the institution
Contact email for the institution
Whether credits are pooled
Institution creation timestamp
AI conversation model used
Maximum completion tokens allowed
Total credits available
Percentage of credits used
Institution identifier
Whether to display agent details
User entitlements
Account type in this institution
User status in institution
Credits awarded to user
Creation timestamp
Last login timestamp
Last keep-alive timestamp
Was this page helpful?