SequenceSequence
Rules
GET/rules

Returns a lightweight list of all rules for the organization. Supports optional filtering by source account.

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

source_id?string

Filter rules by source account 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/rules"
{
  "request_id": "req_01HXYZ7777",
  "data": [
    {
      "id": "rule_01HXYZ1234",
      "nickname": "Auto-save on deposit",
      "description": "Saves 20% of every incoming deposit",
      "status": "enabled",
      "trigger_type": "ON_FUNDS_TRANSFERRED",
      "source": {
        "id": "acc_01HABC4567",
        "type": "income_source",
        "name": "Chase Checking ••4567"
      },
      "created_at": "2024-03-01T10:00:00Z",
      "updated_at": "2024-03-15T14:30:00Z"
    },
    {
      "id": "rule_01HXYZ5678",
      "nickname": "Monthly Amex payment",
      "description": null,
      "status": "enabled",
      "trigger_type": "SCHEDULED",
      "source": {
        "id": "acc_01HDEF0123",
        "type": "external_account",
        "name": "Business Checking"
      },
      "created_at": "2024-02-10T09:00:00Z",
      "updated_at": "2024-02-10T09:00:00Z"
    }
  ]
}
{
  "error": {
    "code": "resource_not_found",
    "message": "Rule with id 'rule_123' was not found."
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key."
  }
}
{
  "error": {
    "code": "forbidden",
    "message": "This API key does not have the required permission."
  }
}

Trigger a rule POST

Manually triggers execution of a rule. Works for any trigger type - use this to run a rule on demand regardless of its configured schedule or trigger condition. For rules with a MANUAL trigger type, an optional `manual_execute_amount` can be provided to override the transfer amount. Returns an execution ID that can be polled via the rule-executions API to track the outcome. The rule ID must be present in the token's `TRIGGER_RULES` resources.

Get a rule GET

Returns the full rule including all steps, conditions, and actions. The rule ID must be present in the token's `READ_RULES` resources.