Bonusly ACTION
List Reward Redemptions
Return paginated reward redemption records for the caller's company, with optional filtering by user email, date range, and fulfillment status. This is a company-wide admin report, not just the caller's own redemptions. 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 Reward Redemptions 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-reward-redemptions",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
bonusly: { authProvisionId: "apn_xxxxxxx" },
userEmail: "User Email",
startDate: "Start Date",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "bonusly-list-reward-redemptions",
"configured_props": {
"bonusly": { "authProvisionId": "apn_xxxxxxx" },
"userEmail": "User Email",
"startDate": "Start Date"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "bonusly",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "bonusly-list-reward-redemptions",
arguments: {
userEmail: "User Email",
startDate: "Start Date",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
userEmail User Email | string | Filter to redemptions made by this user's email address, e.g. john.smith@company.com. Optional |
startDate Start Date | string | Only include redemptions on or after this date, e.g. 2026-01-01. Optional |
endDate End Date | string | Only include redemptions on or before this date, e.g. 2026-06-30. Optional |
unfulfilled Unfulfilled Only | boolean | Set to true to return only redemptions that haven't been fulfilled yet. Optional |
aasmState State | string | Filter by the redemption's internal state (e.g. approved, pending, declined). Bonusly's docs don't publish the full list of accepted values, so confirm against a real redemption's aasm_state field if this filter returns no results. Leave blank to include redemptions in any state. Optional |
range Range | string | A predefined date range shortcut, if supported by your Bonusly plan (e.g. this_month). Start Date/End Date take precedence when both are set. Optional |
page Page | integer | Page number to fetch, starting at 1. Optional |
perPage Per Page | integer | Number of redemptions to return per page. Optional |
sort Sort Field | string | Field to sort results by, e.g. created_at. Optional |
direction Sort Direction | string | Sort direction for the Sort Field, e.g. asc or desc. 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-reward-redemptions
- Version
- 0.0.2
- App
- Bonusly
- Authentication
- API key
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗