Action Detail
Provides detailed information for a specific action by its unique identifier, including any deliverables associated with it.
Endpoint
GET /v1/admin/actions/{actionID}
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
actionID | string | Yes | Unique identifier for the action |
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,
"deliverables": null
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 |
deliverables | array | Deliverables associated with this action (if any) |
Request Example
curl -X GET https://api.rapidmule.com/v1/admin/actions/{{actionID}} \
-H "Authorization: Bearer YOUR_API_KEY"
Use Cases
- Action Configuration: View detailed settings for specific actions
- Deliverables Inspection: Check associated deliverables and rewards
- Action Verification: Verify action status before processing
Error Codes
| Code | Description | Resolution |
|---|---|---|
| 1001 | Payload is null | Check path parameters |
| 4001 | Invalid AuthKey | Verify API key |
| 9001 | Action does not exist | Use valid actionId |
Related Endpoints
- Get Actions - List all actions
- Process Action - Send an action for processing