SequenceSequence
Rule Executions
GET/rule-executions

Returns rule executions for the organization, ordered by created_at descending. Supports filtering by status, trigger type, and date range. rule_id is required and must be present in the token's READ_RULE_EXECUTIONS resources.

AuthorizationClick to expand
ApiKeyAuth
Authorization<token>

Format: ApiKey <key>. Keys are scoped to an organization and carry explicit permissions.

Each key holds a list of permission entries. An entry specifies a scope and a resources constraint. A request returns 403 if the key lacks the required scope, or if the requested resource is outside the key's allowed list.

ScopeResourcesGrants access to
LIST_ACCOUNTSnoneList all accounts in the organization
READ_ACCOUNTSaccount IDs or *Full account details and balance for a specific account
LIST_RULESnoneList all rules in the organization
READ_RULESrule IDs or *Full rule details (steps, conditions, actions) for a specific rule
TRIGGER_RULESrule IDs or *Triggering rule executions
READ_RULE_EXECUTIONSrule IDs or *Rule execution history - rule_id filter required
READ_TRANSFERSaccount IDs or *Transfer history - account_id filter required
MANUAL_TRANSFERlist of { source, target, max_amount? } setsCreating manual transfers
READ_CARDSaccount IDs or *Cards and card transactions - account_id filter required

In: header

Query Parameters

rule_id*string

Rule ID to filter by. Must be present in the token's `READ_RULE_EXECUTIONS` resources.

status?string, Value in "in_progress" | "executed" | "partial" | "failed"

Filter by execution status.

trigger_type?string, Value in "manual" | "scheduled" | "on_funds_transferred"

Filter by trigger type.

from?string

Return executions created at or after this timestamp (ISO 8601).

to?string

Return executions created at or before this timestamp (ISO 8601).

first?integer

Number of results to return. Defaults to 20, maximum 100.

after?string

Cursor from a previous response's `page_info.end_cursor` to fetch the next page.

Header Parameters

X-Request-ID?string

A client-provided request identifier echoed back in the response `X-Request-ID` header and `request_id` body field. If omitted, the server generates one.

Response Body

application/json

application/json

application/json

curl -X GET "https://api.getsequence.io/api/v1/rule-executions?rule_id=string"
{
  "request_id": "req_01HABC8888",
  "data": [
    {
      "id": "rex_01HABC4567",
      "rule_id": "rule_01HXYZ1234",
      "rule_name": "Save 20% of paycheck",
      "trigger_type": "on_funds_transferred",
      "status": "executed",
      "created_at": "2024-04-23T09:15:00Z"
    },
    {
      "id": "rex_01HDEF0123",
      "rule_id": "rule_01HXYZ1234",
      "rule_name": "Save 20% of paycheck",
      "trigger_type": "scheduled",
      "status": "partial",
      "created_at": "2024-04-20T08:00:00Z"
    },
    {
      "id": "rex_01HGHI7890",
      "rule_id": "rule_01HABC9999",
      "rule_name": "Pay Amex on payday",
      "trigger_type": "manual",
      "status": "failed",
      "created_at": "2024-04-18T14:30:00Z"
    }
  ],
  "page_info": {
    "has_next_page": true,
    "end_cursor": "cursor_01HGHI7890"
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key."
  }
}
{
  "error": {
    "code": "forbidden",
    "message": "This API key does not have the required permission."
  }
}

Update a rule PUTv2

Fully replaces the rule configuration. All required fields must be provided. If the rule's status is `enabled`, the update will set it to `disabled` and require a human to review and re-enable it in the Sequence app before it can be triggered again.

Get a rule execution GET

Returns the full rule execution including trigger details, outcome, and transfer IDs. The execution's rule ID must be present in the token's `READ_RULE_EXECUTIONS` resources.