View as Markdown
Bonusly icon

Bonusly ACTION

List Users In Location

List the users in the authenticated caller's company who belong to a specific location. Use this to enumerate a location's roster - unlike Search Users, no search term is required, so it returns everyone based at the location. 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 Users In Location 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-users-in-location",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    bonusly: { authProvisionId: "apn_xxxxxxx" },
    location: "Location",
    search: "Search",
  },
})

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 Users In Location inputs
Property Type Description
location Location string
The location to list users for, e.g. Berlin. This is an exact match - a partial or differently-cased name returns no users. Use List Locations to find the exact names configured for your company.
Required
search Search string
Narrow the location's roster by matching this text against user names or emails, e.g. john or john.smith@company.com. Omit to return every user at the location.
Optional
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-list-users-in-location
Version
0.0.2
App
Bonusly
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes