Skip to main content
POST
/
api
/
admin
/
userInstitutions
Get users associated with institutions
curl --request POST \
  --url https://pria.praxislxp.com/api/admin/userInstitutions \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "account": "<string>",
  "institution": "<string>",
  "accountType": "user",
  "usersearch": "<string>",
  "emptyInstitutions": true,
  "page": 1,
  "pageSize": 100,
  "limitsearch": 123
}
'
{
  "success": true,
  "data": [
    {
      "lastConversation": {
        "course_id": 123,
        "course_name": "<string>"
      },
      "digitaltwin": true,
      "_id": "<string>",
      "user": {
        "_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,
          "status": "active",
          "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>",
            "description": "<string>",
            "status": "active",
            "credits": 123,
            "created": "2023-11-07T05:31:56Z"
          },
          "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",
        "lastActivityAt": "2023-11-07T05:31:56Z",
        "conversationModel": "<string>",
        "account": {
          "_id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "status": "active",
          "credits": 123,
          "created": "2023-11-07T05:31:56Z"
        },
        "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"
    }
  ],
  "total": 123,
  "hasMore": true,
  "page": 123,
  "pageSize": 123,
  "message": "<string>"
}

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

institution
string

Institution ID to filter entitlements

accountType
enum<string>

Account type filter (user, admin)

Available options:
user,
admin
usersearch
string

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

emptyInstitutions
boolean

Whether to filter for users with no institution (super admin only)

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

Response

Successfully retrieved user institution data

success
boolean

Whether the request was successful

data
object[]

Array of user institution relationships

total
integer

Total number of matching entitlements

hasMore
boolean

Whether more results are available

page
integer

Current page number

pageSize
integer

Number of results per page

message
string

Response message