View as Markdown
Bonusly icon

Bonusly ACTION

Search Users

Search users in the authenticated caller's company by name or email. This is a search, not a full company directory dump - a Search Term is required and matches on name or email. To list users without a search term, use List Users In Department, List Users In Location, or List Top-Level Users instead. 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 Search Users 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-search-users",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    bonusly: { authProvisionId: "apn_xxxxxxx" },
    searchTerm: "Search Term",
    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.

Search Users inputs
Property Type Description
searchTerm Search Term string
Text to match against user names or emails, e.g. john or john.smith@company.com.
Required
pageSize Page Size integer
Maximum number of users 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-search-users
Version
0.0.2
App
Bonusly
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes