Skip to main content
POST
/
api
/
admin
/
assistants
Retrieve filtered list of assistants
curl --request POST \
  --url https://pria.praxislxp.com/api/admin/assistants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "minimum": true,
  "institution": "665653e9f7e4f4f1b5c6ef1b"
}'
{
  "success": true,
  "data": [
    {
      "_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "instructions": "<string>",
      "picture_url": "<string>",
      "status": "active",
      "liked_count": 123,
      "admin_only": true,
      "institution_shared": true,
      "remember_history": 123,
      "created": "2023-11-07T05:31:56Z",
      "argument_1": "<string>",
      "argument_5": "<string>",
      "editable_others": true
    }
  ]
}

Authorizations

Authorization
string
header
required

JWT token passed in x-access-token header

Body

application/json
minimum
boolean

Whether to return minimal assistant data

institution
string

Institution ID to filter assistants by

Response

Successfully retrieved assistants list

success
boolean

Indicates if the request was successful

data
object[]

Array of assistant objects