Bonusly API Documentation
This is the complete API documentation for connecting to the Bonusly API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet Bonusly: Bonusly is an employee recognition and rewards platform for peer-to-peer recognition, incentives, and engagement. Keep reading to get started.
Quickstart
Before you run your first Bonusly request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one Bonusly connection — create or choose one in Connections. Note its
connectionId.
Every Bonusly action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/bonusly/actions/{actionSlug}/runYou need a MindCloud API Key and a Bonusly connection. Then call an action such as Me:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/bonusly/actions/me/run" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"connectionId": "$CONNECTION_ID",
"arguments": {}
}'Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authenticate with a MindCloud API Key plus a connectionId for your Bonusly account. See Bonusly API Authentication for the full flow and how to get your connection credentials.
Bonusly actions
All 46 published actions for this Bonusly version. Each page documents the endpoint, arguments, and response controls.
- POSTAdmin Create User
- DELETEAdmin Deactivate User
- PUTAdmin Update User
- PUTApprove Custom Reward Redemptions
- POSTCreate Bonus
- POSTCreate Redemption
- POSTCreate Webhook
- PUTFulfill Custom Reward Redemptions
- GETGet Company Value Hashtags Received
- GETGet Hashtags Received
- GETGet Participation Rates
- GETGet Points Received
- GETGet Popular Words
- GETGet Recognition Add-ons
- GETGet Recognition Rates
- GETGet Recognition Received
- GETGet SCIM Metadata
- GETGet User Count
- GETLeaderboards
- GETList Achievements
- GETList API Keys
- GETList Bonuses
- GETList Custom Rewards Redemptions
- GETList Redemptions
- GETList Rewards
- GETList SCIM Schemas
- GETList User Achievements
- GETList User Bonuses
- GETList User Redemptions
- GETList Users
- GETList Webhooks
- GETMe
- DELETERemove Webhook
- GETRetrieve Bonus
- GETRetrieve Redemption
- GETRetrieve Reward
- GETRetrieve User
- DELETESCIM Activate Or Deactivate User
- POSTSCIM Create User
- GETSCIM List Users
- GETSCIM Retrieve User
- PUTSCIM Update User
- GETSearch Users
- GETTrends
- PUTUpdate Webhook
- GETXML List Bonuses
Related apps
More apps on the Universal API, behind the same REST shape. Or browse all apps.