---
title: "GET /api/automation-rules/"
method: GET
path: "/api/automation-rules/"
tags: ["Automation Rules"]
---

# GET /api/automation-rules/

`GET /api/automation-rules/`

This company's automation rules. `tab=archive` returns archived rules instead of the live ones, and `blockedOnly` narrows to rules whose most recent run blocked something. Each row carries its condition tree already flattened to text and the counts from its last run.

## Query parameters

- `tab` 'active' | 'archive'
- `blockedOnly` boolean
- `sort` string
- `limit` integer
- `offset` integer

## Response `200`

Default Response

- object
  - `metadata` object, required
    - `success` boolean, required — True when the request succeeded.
    - `pagination` object
      - `page` number, required — Current page number (1-based).
      - `limit` number, required — Page size used for this response. Endpoint defaults vary — see each endpoint's limit parameter.
      - `total` number, required — Total number of records across all pages.
      - `totalPages` number, required — Total number of pages. Iterate until page reaches totalPages.
  - `data` object, required
    - `rules` object[], required
      - `id` string, required
      - `name` string, required
      - `description` string, required
      - `status` 'draft' | 'active' | 'paused' | 'archived', required
      - `resourceType` string, required
      - `workflowId` string, required
      - `workflowKey` string, required
      - `workflowName` string, required
      - `conditionsText` string, required
      - `triggerCron` string, required
      - `timezone` string, required
      - `lastRunAt` string, required
      - `nextRunAt` string, required
      - `lastRun` object, required
        - `status` string, required
        - `matchedCount` integer, required
        - `firedCount` integer, required
        - `blockedCount` integer, required
        - `failedCount` integer, required
      - `updatedAt` string, required
    - `blockedCount` integer, required

## Other responses

- `401` — Default Response
- `403` — Default Response

---

[API](https://skmtc.net/retraced/apis/api-reference.md) · [All operations](https://skmtc.net/retraced/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/retraced/api-reference/revisions/60d6c901bc4e/schema)
