Get Deliverables

Provides a list of all deliverables in your gamification system. Deliverables are rewards issued to players and come in three types: Prize, Content, and Notification.

Endpoint

GET /v1/admin/deliverables

Response

{
"code": 200,
"data": [
  {
    "uid": "13f1b67e57a548f8bd73e947c3564b90",
    "description": "Can be assigned to triggers/badges to allow the players to Spin.",
    "isPercentage": false,
    "label": "Spin Credit",
    "type": "Prize",
    "imageName": "https://rapidmulestorage.blob.core.windows.net/images/20b19c63-15d6-4621-a8ab-99b70a239ad6_spin.png"
  },
  {
    "uid": "41c8680620d94498b295e53e7db96045",
    "description": null,
    "isPercentage": false,
    "label": "Gold",
    "type": "Prize",
    "imageName": "https://rapidmulestorage.blob.core.windows.net/images/a2280ab9-1eec-4625-b97e-d0cbe960dbe0_coin.png"
  },
  {

Response Fields

Field	Type	Description
uid	string	Unique identifier for the deliverable
label	string	Display name of the deliverable
description	string	Description of the deliverable's purpose
type	string	Deliverable type: Prize, Content, or Notification
imageName	string	URL to the deliverable's icon/image
isPercentage	boolean	Whether the amount represents a percentage

Deliverable Types

Type	Description	Use Cases
Prize	Tangible/virtual rewards	Coins, credits, coupons, items
Content	Dynamic content	Banners, carousels, personalized content
Notification	System/user notifications	Feature unlocks, alerts, messages

Request Example

curl -X GET https://api.rapidmule.com/v1/admin/deliverables \
  -H "Authorization: Bearer YOUR_API_KEY"

Use Cases

• Filter by Type: Organize deliverables by Prize, Content, or Notification types
• Percentage-Based Rewards: Find deliverables that use percentage values (like discount coupons)
• Reward Store UI: Build reward store interfaces showing available items

Error Codes

Code	Description	Resolution
1001	Payload is null	Check request parameters
4001	Invalid AuthKey	Verify API key

Learn More

For a deeper understanding of Deliverables, see Core Concepts - Deliverables.