Get Actions

Provides a list of all active actions in your gamification system. Use this endpoint to retrieve configuration details for all actions you've created.

Endpoint

GET /v1/admin/actions

Response

{
"code": 200,
"data": [
  {
    "uid": "c1991d02872947e78435d15602b48581",
    "identifier": "Bet",
    "points": 1,
    "pointGap": 0,
    "cost": 0,
    "costLabel": null,
    "createDate": "2023-08-15T10:10:46.293",
    "imageName": "https://rapidmulestorage.blob.core.windows.net/images/6c511fde-de2c-4a50-9ddb-1407061d5b46_casino-chip.png",
    "isUserAttribute": false,
    "isActive": true,
    "actionObjects": [

Response Fields

Field	Type	Description
uid	string	Unique identifier for the action
identifier	string	The action name/identifier
points	number	Points awarded for this action
pointGap	number	Minimum time gap between point awards
cost	number	Cost to perform this action (if applicable)
costLabel	string	Label for the cost deliverable
createDate	string	ISO 8601 timestamp of when the action was created
imageName	string	URL to the action's icon/image
isUserAttribute	boolean	Whether this action represents a user attribute
isActive	boolean	Whether this action is currently active
actionObjects	array	Parameters/attributes captured with this action (null when the action has none)
actionObjects[].label	string	Name of the parameter
actionObjects[].actionUId	string	UID of the parent action
actionObjects[].type	number	Parameter data type
actionObjects[].typeLabel	string	Human-readable data type (e.g. Array)

Request Example

curl -X GET https://api.rapidmule.com/v1/admin/actions \
  -H "AuthKey: YOUR_API_KEY"

Use Cases

• Admin Dashboard: Display all available actions in your admin panel
• Action Dropdown: Populate action selection dropdowns
• Analytics: Analyze action configurations and point awards

Error Codes

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

Note

This endpoint returns only active actions by default. To retrieve all actions including inactive ones, use the appropriate filter parameter if supported.