# Bonusly API Documentation

This is the complete API documentation for connecting to the Bonusly API using MindCloud's Universal API.

MindCloud offers one normalized API to access 3,400+ apps from a single place. It centralizes authentication and normalizes app APIs so they are easier and more consistent to use.

## Quickstart

1. A **MindCloud account** — sign in or create an account at [MindCloud](https://app.mindcloud.co).
2. A **MindCloud API Key** — create one in [API Keys](https://app.mindcloud.co/user/api-keys). Keep it on your server.
3. At least one **Bonusly connection** — create or choose one in [Connections](https://app.mindcloud.co/credentials). Note its `connectionId`.

```text
POST https://connect.mindcloud.co/v2/universal/apps/bonusly/actions/{actionSlug}/run
```

## Bonusly actions

- POST `admin-create-user` Admin Create User
- DELETE `admin-deactivate-user` Admin Deactivate User
- PUT `admin-update-user` Admin Update User
- PUT `approve-custom-reward-redemptions` Approve Custom Reward Redemptions
- POST `create-bonus` Create Bonus
- POST `create-redemption` Create Redemption
- POST `create-webhook` Create Webhook
- PUT `fulfill-custom-reward-redemptions` Fulfill Custom Reward Redemptions
- GET `get-company-value-hashtags-received` Get Company Value Hashtags Received
- GET `get-hashtags-received` Get Hashtags Received
- GET `get-participation-rates` Get Participation Rates
- GET `get-points-received` Get Points Received
- GET `get-popular-words` Get Popular Words
- GET `get-recognition-add-ons` Get Recognition Add-ons
- GET `get-recognition-rates` Get Recognition Rates
- GET `get-recognition-received` Get Recognition Received
- GET `get-scim-metadata` Get SCIM Metadata
- GET `get-user-count` Get User Count
- GET `leaderboards` Leaderboards
- GET `list-achievements` List Achievements
- GET `list-api-keys` List API Keys
- GET `list-bonuses` List Bonuses
- GET `list-custom-rewards-redemptions` List Custom Rewards Redemptions
- GET `list-redemptions` List Redemptions
- GET `list-rewards` List Rewards
- GET `list-scim-schemas` List SCIM Schemas
- GET `list-user-achievements` List User Achievements
- GET `list-user-bonuses` List User Bonuses
- GET `list-user-redemptions` List User Redemptions
- GET `list-users` List Users
- GET `list-webhooks` List Webhooks
- GET `me` Me
- DELETE `remove-webhook` Remove Webhook
- GET `retrieve-bonus` Retrieve Bonus
- GET `retrieve-redemption` Retrieve Redemption
- GET `retrieve-reward` Retrieve Reward
- GET `retrieve-user` Retrieve User
- DELETE `scim-activate-or-deactivate-user` SCIM Activate Or Deactivate User
- POST `scim-create-user` SCIM Create User
- GET `scim-list-users` SCIM List Users
- GET `scim-retrieve-user` SCIM Retrieve User
- PUT `scim-update-user` SCIM Update User
- GET `search-users` Search Users
- GET `trends` Trends
- PUT `update-webhook` Update Webhook
- GET `xml-list-bonuses` XML List Bonuses