Skip to main content
POST
/
api
/
admin
/
tools
Get list of tools
curl --request POST \
  --url https://pria.praxislxp.com/api/admin/tools \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "institution": "<string>",
  "type": "<string>",
  "minimum": true,
  "page": 1,
  "pageSize": 100
}
'
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "responseLength": 123,
      "responseDurationMs": 123,
      "success": true,
      "_id": "<string>",
      "description": "<string>",
      "type": "<string>",
      "schema": {},
      "endpoint": "<string>",
      "status": "active",
      "institution": "<string>",
      "created": "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
institution
string

Filter by institution ID

type
string

Filter by tool type

minimum
boolean

Return minimal data (bypasses pagination)

page
integer
default:1

Page number (1-based, ignored if minimum=true)

Required range: x >= 1
pageSize
integer
default:100

Number of results per page (ignored if minimum=true)

Required range: 1 <= x <= 5000

Response

200 - application/json

Tools retrieved successfully

success
boolean

Request success status

data
object[]

Array of tool objects

total
integer

Total number of matching tools (omitted if minimum=true)

hasMore
boolean

Whether more results are available (omitted if minimum=true)

page
integer

Current page number (omitted if minimum=true)

pageSize
integer

Number of results per page (omitted if minimum=true)

message
string

Response message