View as Markdown
Brillium icon

Brillium ACTION

List Assessments

Retrieve all Assessments for a Brillium account. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Brillium account once, then configure and run List Assessments from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "brillium-list-assessments",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    brillium: { authProvisionId: "apn_xxxxxxx" },
    accountId: "Account ID",
    page: 10,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Assessments inputs
Property Type Description
accountId Account ID string
The ID of the Workspace the assessment resides within
Required Dynamic
page Page integer
The page of results to return. Default is 1
Optional
pageSize Page Size integer
The number of results to return. Must be between 1 - 1000. Default is 1000
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
brillium-list-assessments
Version
0.0.3
App
Brillium
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes