Skip to main content
POST
/
api
/
admin
/
institutions
Retrieve list of institutions
curl --request POST \
  --url https://pria.praxislxp.com/api/admin/institutions \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "minimum": true
}
'
{
  "success": true,
  "data": [
    {
      "_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
    }
  ],
  "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
minimum
boolean

Whether to return minimal institution data (bypasses pagination)

compact
boolean

Whether to return compact institution data

account
string

Account ID(s) to filter institutions (space-separated for multiple)

institutionsearch
string

Search term for institutions (matches name, AI name, publicId)

statusFilter
enum<string>
default:active

Filter institutions by lifecycle status. 'active' returns only active instances, 'inactive' returns only inactive, 'all' returns both. Deleted institutions are always excluded.

Available options:
active,
inactive,
all
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 institutions list

success
boolean

Whether the request was successful

data
object[]

Array of institution objects

total
integer

Total number of matching institutions

hasMore
boolean

Whether more results are available beyond the current page

page
integer

Current page number

pageSize
integer

Number of results per page

message
string

Response message