API reference · Automation

GET/api/v1/automation/rules

List automation rules

Returns a paginated list of automation rules scoped to the authenticated tenant. Authentication uses x-api-key with optional x-tenant-id, then RBAC requires automation:read. The controller validates query params with automationRulesListSchema, parses page/limit from the URL, and the service enforces tenant filtering on automation_rules.

RBAC · automation

Query parameters

pagestringOptional

Page number as a query string. Defaults to 1.

limitstringOptional

Page size as a query string. Must parse to 1 through 100; defaults to 25.

sortstringOptional

Accepted by shared list query validation; service currently orders rules by created_at desc.

orderstringOptional

Accepted by shared list query validation.

searchstringOptional

Accepted by shared filter validation.

created_fromstring <date-time>Optional

Accepted by shared filter validation.

created_tostring <date-time>Optional

Accepted by shared filter validation.

updated_fromstring <date-time>Optional

Accepted by shared filter validation.

updated_tostring <date-time>Optional

Accepted by shared filter validation.

is_activestringOptional

Accepted by shared filter validation and transformed to boolean.

namestringOptional

Optional rule name filter.

statusstringOptional

Filter by automation rule status.

trigger_typestringOptional

Filter by trigger type.

prioritystringOptional

Filter by priority level.

template_categorystringOptional

Filter template category.

created_bystring <uuid>Optional

Filter by creator user UUID from automation_rules.created_by.

last_executed_fromstring <date-time>Optional

Filter for rules last executed at or after timestamp.

last_executed_tostring <date-time>Optional

Filter for rules last executed at or before timestamp.

execution_count_minintegerOptional

Minimum execution count filter.

execution_count_maxintegerOptional

Maximum execution count filter.

Response body

Success response 200 · schema AutomationRuleListResponse

dataarray of AutomationRuleRequired

itemsobject

rule_idstring <uuid>Required

Rule UUID generated with crypto.randomUUID when a rule is created.

tenantstring <uuid>Required

Tenant UUID scoped from API key authentication.

namestringRequired

Rule display name.

descriptionstringNullable

statusstringRequired

Current automation rule status.

Enum: activeinactivedrafterror

prioritystringRequired

Current automation rule priority.

Enum: lownormalhighcritical

trigger_typestringRequired

Trigger type used to start rule execution.

Enum: time_basedevent_basedcondition_basedmanualrecurringwebhook

trigger_configobjectRequired

Trigger configuration object stored with the rule.

conditionsarray of AutomationRuleCondition

Optional additional rule conditions.

itemsobject

fieldstringRequired

Field path evaluated for this condition.

operatorstringRequired

Enum: equalsnot_equalsgreater_thanless_thangreater_than_or_equalless_than_or_equalcontainsnot_containsstarts_withends_withinnot_inexistsnot_existsregex_match

valueany

Condition comparison value.

data_typestring

Enum: stringnumberbooleandatearrayobject

condition_logicstring

Condition combination logic.

Enum: andor

actionsarray of AutomationRuleActionRequired

Ordered action list for this rule.

itemsobject

typestringRequired

Automation action type.

Enum: email_notificationsms_notificationwebhook_calldatabase_updateticket_creationticket_updateproject_updatetime_entry_creationinvoice_generationcustom_scriptworkflow_executionsystem_command

configobjectRequired

Action configuration object. Expected keys depend on action type.

orderintegerRequired

Execution order (1-based).

≥ 1

continue_on_errorboolean

Continue execution after a failed action.

timeout_secondsinteger

Optional per-action timeout in seconds.

≥ 1

retry_attemptsinteger

Optional retry count for this action.

≥ 0 · ≤ 5

max_concurrent_executionsinteger

≥ 1

execution_timeout_minutesinteger

≥ 1

retry_failed_executionsboolean

is_templateboolean

template_categorystringNullable

tagsarray of string

itemsstring

metadataobject

notification_settingsobject

notify_on_successboolean

notify_on_failureboolean

notification_emailsarray of string

itemsstring <email>

notification_webhooksarray of string

itemsstring <uri>

created_bystring <uuid>Nullable

User UUID from API key context that created the rule.

created_atstring <date-time>

updated_atstring <date-time>

execution_countinteger

≥ 0

last_executedstring <date-time>Nullable

execution_statisticsobject

Included on GET /rules/{id} by service lookup helper.

_linksobject

HATEOAS links generated by the automation controller. Some generic links may point to methods not implemented by a route file.

paginationobjectRequired

pageintegerRequired

Current page number.

limitintegerRequired

Page size.

totalintegerRequired

Total matching executions.

totalPagesintegerRequired

Total page count.

hasNextbooleanRequired

Whether another page exists.

hasPrevbooleanRequired

Whether a previous page exists.

metaobject

filtersobject

resourcestring

Enum: automation_rule

Response codes

200

Automation rules returned successfully.

400

Query parameter validation failed.

401

API key is missing, invalid, expired, over limit, or the key user was not found.

403

Authenticated user lacks automation:read permission.

500

Unexpected automation rules listing failure.

GET /api/v1/automation/rules

cURL

curl -X GET "https://algapsa.com/api/v1/automation/rules?page=string&limit=string&sort=string&order=asc&search=string&created_from=2026-04-18T15%3A22%3A14Z" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/automation/rules?page=string&limit=string&sort=string&order=asc&search=string&created_from=2026-04-18T15%3A22%3A14Z", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

C#

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/v1/automation/rules?page=string&limit=string&sort=string&order=asc&search=string&created_from=2026-04-18T15%3A22%3A14Z");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": [
    {
      "rule_id": "01HN2K7VRB9PQ3Y0000000000",
      "tenant": "01HN2K7VRB9PQ3Y0000000000",
      "name": "string",
      "description": "string",
      "status": "active",
      "priority": "low",
      "trigger_type": "time_based",
      "trigger_config": {},
      "conditions": [
        {
          "field": "string",
          "operator": "equals",
          "value": null,
          "data_type": "string"
        }
      ],
      "condition_logic": "and",
      "actions": [
        {
          "type": "email_notification",
          "config": {},
          "order": 1,
          "continue_on_error": false,
          "timeout_seconds": 1,
          "retry_attempts": 0
        }
      ],
      "max_concurrent_executions": 1,
      "execution_timeout_minutes": 1,
      "retry_failed_executions": false,
      "is_template": false,
      "template_category": "string",
      "tags": [
        "string"
      ],
      "metadata": {},
      "notification_settings": {
        "notify_on_success": false,
        "notify_on_failure": false,
        "notification_emails": [
          "user@example.com"
        ],
        "notification_webhooks": [
          "https://example.com"
        ]
      },
      "created_by": "01HN2K7VRB9PQ3Y0000000000",
      "created_at": "2026-04-18T15:22:14Z",
      "updated_at": "2026-04-18T15:22:14Z",
      "execution_count": 0,
      "last_executed": "2026-04-18T15:22:14Z",
      "execution_statistics": {},
      "_links": {}
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 1,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrev": false
  },
  "meta": {
    "filters": {},
    "resource": "automation_rule"
  }
}