Get Action Response

Retrieves the result of a previously initiated process action request using a unique referenceId.

This endpoint is useful when you need to check the outcome of an action that was processed asynchronously or when you want to retrieve the results at a later time.

Endpoint

GET /v1/action/get-response?referenceId={referenceId}

Query Parameters

Parameter	Type	Required	Description
referenceId	string	Yes	A unique identifier for the action reference in source system

Response

Success Response

{
"code": 200,
"data": {
  "playerId": "4f9c9e5569524cb18e77d5b804b1e35a",
  "referenceId": "1758710351004",
  "badges": null,
  "triggers": null,
  "achievedLevel": null,
  "earnedPoints": 2.5,
  "deliverables": null
}
}

Response Fields

Field	Type	Description
playerId	string	The player's unique identifier
referenceId	string	The action's unique identifier
badges	array	Badges earned from this action (if any)
triggers	array	Triggers activated from this action (if any)
achievedLevel	object	Level achieved from this action (if any)
earnedPoints	number	Points earned from this action
deliverables	array	Deliverables issued from this action (if any)

Request Example

curl -X GET https://api.rapidmule.com/v1/action/get-response?referenceId={{referenceId}} \
  -H "Authorization: Bearer YOUR_API_KEY"

Use Cases

• Asynchronous Processing: Check action results at a later time after initial processing
• Retry Logic: Retrieve results if initial action request fails due to network issues
• Audit Trail: Query historical action results for auditing and support purposes

Error Codes

Code	Description	Resolution
1001	Payload is null	Check query parameters
4001	Invalid AuthKey	Verify API key
5001	Action not found	Check referenceId validity

Best Practice

Store the referenceId in your system to enable later retrieval of action results for analytics, debugging, or user support purposes.