get https://rule-engine-api.frisbii.com/v1/action
Retrieve a list of scheduled actions in the Rule Engine
Preview StatusAll Rule Engine actions are currently in PREVIEW phase. When creating actions:
- Monitor action execution results
- Review scheduled actions regularly
- Report any issues encountered to our support team
This endpoint allows you to retrieve a list of actions that have been scheduled in the Rule Engine. You can use filters to narrow down the results and find specific actions based on your requirements.
Key Features
- Retrieve all scheduled actions
- Filter actions by entity id (subscription handle), type, state
- Paginated results with configurable page size
Query Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
size | integer | Page size between 10 and 100. Default: 20 | 10 |
next_page_token | string | Next page token from previous response to get next page | MTYzMjkxNDc4NTAwMDoxMA |
id | string | ID of the action to filter by | act-1234567890 |
entity_id | string | ID of the entity that the actions is associated with | sub-1234567890 |
type | string | Type of the action to filter by | pause_subscription |
state | string | State of the action to filter by | new, success, failure, retrying, nothing_to_do |
Response
The response contains a paginated list of actions with metadata:
{
"size": 20,
"count": 15,
"content": [
{
"id": "action-1234567890",
"state": "new",
"created": "2021-09-01T12:00:00Z",
"details": {
// Action-specific details
},
"action": "add_addon_to_subscription",
"schedule": {
"execution_date": "2023-12-01T10:00:00Z"
},
"entity_id": "sub-0001",
"entity_type": "subscription"
}
// ... more actions
],
"next_page_token": "MTYzMjkxNDc4NTAwMDoxMA"
}Response Fields
| Field | Type | Description |
|---|---|---|
size | integer | Page size used in paginated list |
count | integer | Number of elements in current page. If less than page size, it's the last page |
to | string | Local date and time range used as to (exclusive) |
from | string | Local date and time range used as from (inclusive) |
content | array | List of actions for current page |
next_page_token | string | Pagination token for next page. If not present, last page has been reached |
Example Usage
Get All Actions
curl -X GET "https://rule-engine-api.frisbii.com/v1/action" \
-H "Authorization: Basic <base64-encoded-credentials>"Filter by Subscription
curl -X GET "https://rule-engine-api.frisbii.com/v1/action?entity_id=sub-1234567890" \
-H "Authorization: Basic <base64-encoded-credentials>"Filter by Action Type and State
curl -X GET "https://rule-engine-api.frisbii.com/v1/action?type=pause_subscription&state=new" \
-H "Authorization: Basic <base64-encoded-credentials>"