SequenceSequence
Rule Executions
GET/rule-executions/{id}

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.

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

Path Parameters

id*string

The rule execution ID.

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

application/json

curl -X GET "https://api.getsequence.io/api/v1/rule-executions/string"

{
  "request_id": "req_01HABC4567",
  "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",
    "trigger_details": {
      "type": "on_funds_transferred",
      "amount_in_cents": 500000
    },
    "step_index_matched": 0,
    "conditions_not_met": false,
    "transfers_attempted": 2,
    "transfers_completed": 2,
    "transfers_failed": 0,
    "transfers_pending": 0,
    "transfer_ids": [
      "txr_01HABC1111",
      "txr_01HABC2222"
    ],
    "error_message": null,
    "next_attempt_at": null
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key."
  }
}
{
  "error": {
    "code": "forbidden",
    "message": "This API key does not have the required permission."
  }
}
{
  "error": {
    "code": "resource_not_found",
    "message": "Rule execution with id 'rex_123' was not found."
  }
}

List rule executions GET

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.

Transfer created Webhookv2

Sent when a new transfer is created, regardless of its initial status. This fires for all origins - rule, user, money_in, money_out, etc. Fetch the full transfer via `GET /transfers/{id}`.