View as Markdown
Bonusly icon

Bonusly ACTION

List Departments

List the distinct departments configured for users in the authenticated caller's company, with a user count for each. Call this first to discover the exact department names accepted by List Users In Department, which matches exactly and returns nothing for a misspelled or differently-cased name. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Bonusly account once, then configure and run List Departments 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: "bonusly-list-departments",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    bonusly: { authProvisionId: "apn_xxxxxxx" },
    search: "Search",
    pageSize: 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 Departments inputs
Property Type Description
search Search string
Narrow the results to departments whose name starts with this text, e.g. Eng matches Engineering. This is a prefix match, so it will not match text in the middle of a name. Omit to return every department.
Optional
pageSize Page Size integer
Maximum number of departments to return in this page. Defaults to Bonusly's standard page size if omitted.
Optional
cursor Cursor string
Opaque pagination cursor for fetching the next page of results. Use the next_cursor value returned in the previous response. Omit to fetch the first page.
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
bonusly-list-departments
Version
0.0.2
App
Bonusly
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes