Dark mode is now available in beta
cURL
curl --request POST \ --url http://localhost:3000/api/admin/users \ --header 'Content-Type: application/json' \ --header 'x-access-token: <api-key>' \ --data ' { "institution": "<string>", "accountType": "<string>", "usersearch": "<string>", "limitsearch": 123 } '
{ "success": true, "data": [ { "_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" } ], "message": "<string>" }
Retrieves a list of users based on search criteria including institution, account type, and search terms
JWT token passed in x-access-token header
Institution ID to filter users
Account type filter
Search term for users
Maximum number of results to return
Successfully retrieved user list
Request success status
Array of user objects
Show child attributes
Response message
Was this page helpful?