Skip to main content
GET
/
api
/
public
/
v1
/
automation
/
executions
List all rule executions
curl --request GET \
  --url https://app.msportal.ai/api/public/v1/automation/executions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ruleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "triggerSource": "<string>",
      "matchedCount": 123,
      "status": "<string>",
      "actionsExecuted": [
        {
          "actionId": "<string>",
          "actionType": "<string>",
          "status": "success",
          "result": "<unknown>",
          "error": "<string>"
        }
      ],
      "errorMessage": "<string>",
      "startedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "ruleName": "<string>",
      "triggerData": "<unknown>",
      "triggeredBy": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    }
  ],
  "pagination": {
    "page": 2,
    "limit": 50,
    "totalCount": 123,
    "totalPages": 123,
    "hasNextPage": true,
    "hasPrevPage": true
  }
}

Authorizations

​
Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

​
page
number
default:1

Page number

Required range: x >= 1
​
limit
number
default:25

Items per page

Required range: 1 <= x <= 100
​
status
enum<string>

Filter by status

Available options:
pending,
processing,
completed,
failed,
dry_run
​
triggerSource
string

Filter by trigger source

Response

List of all rule executions

​
data
object[]
required

Array of rule executions

​
pagination
object
required