Listar automações
RegistosGET /automations
Returns the tenant's automation rules with cursor pagination (limit defaults to 20, at most 100; pass next_cursor as after). Each rule includes its trigger, conditions, actions, status and current version. Requires automations:read.
Parâmetros
limitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
statusReturn only rules in this state: enabled or disabled; omit for both.
um de
enabled,disabled
Devolve
200 Rules
Mostrar atributos
dataMostrar atributos filhos
namedescriptiontriggerMostrar atributos filhos
typeum de
invoice.issued,invoice.overdue,invoice.paid,payment.received,reading.missing,reading.review_required,consumption.anomaly,ticket.created,ticket.unresolved,work_order.overdue,disconnection.notice_expired,schedule, …daysN for invoice.overdue, ticket.unresolved, work_order.overdue; cycle length of reading.missing
cronFive-field cron expression, schedule only
timezonethresholdPercentage of the average that fires consumption.anomaly
conditionsMostrar atributos filhos
fieldamount (cents), days_overdue, customer_category, service_area, or metadata.<key>
operatorum de
eq,neq,gt,gte,lt,lte,in,not_in,contains,existsvalue
actionsMostrar atributos filhos
typeum de
send_notification,create_collection_case,issue_disconnection_notice,apply_late_fee,create_work_order,create_ticket,set_metadata,call_webhookdelay_minutesMinutes after the previous step
paramssend_notification: event_type, template_key, recipient_type, recipient_id, channels (email, in_app), message and in_app_title (the default text, in the utility's default language; message up to 2000 bytes, in_app_title up to 160), and optional translations, an object keyed by locale (pt-MZ or en-US) whose values hold message and/or in_app_title for recipients in that locale. At send time the recipient's notification language (else the utility's default language) selects its version, falling back to the default text field by field; translations require a default message. A rule with no text uses the template catalogue's starter text for its template_key, if any, and otherwise sends nothing on direct channels. Invalid text is rejected with code request.invalid and the offending field in params.field. create_collection_case: aging_bucket, notes. issue_disconnection_notice: cutoff_days, delivered_via. apply_late_fee: amount_cents or percent, reason. create_work_order: order_type, priority, description, crew_id. create_ticket: subject, description, category, priority. set_metadata: values. call_webhook: url, secret.
enabledtemplate_keyidtenant_idstatusum de
enabled,disabledcreated_bycreated_atupdated_at
has_morenext_cursor
Permissões automations:read · Funções: admin, analyst, customer_service, finance, operations, owner
curl -X GET "$BUSINESS_API/automations" \
-H "Authorization: Bearer sk_test_..."
# Sem comando CLI equivalente; use cURL ou HTTP directo.
const res = await fetch("$BUSINESS_API/automations", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/automations",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/automations", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"data": [
{
"name": "Ana Matsinhe",
"description": "Leitura confirmada no local.",
"trigger": {
"type": "invoice.issued",
"days": 1,
"cron": "cron",
"timezone": "Africa/Maputo",
"threshold": 1
},
"conditions": [
{
"field": "field",
"operator": "eq"
}
],
"actions": [
{
"type": "send_notification",
"delay_minutes": 1,
"params": {}
}
],
"enabled": true,
"template_key": "template key",
"id": "aut_2w073m0Tz4ynrGAZLEIP3cmHTUK",
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"status": "enabled",
"created_by": "created by",
"created_at": "2026-11-19T09:30:00Z",
"updated_at": "2026-11-19T09:30:00Z"
}
],
"has_more": true,
"next_cursor": "next cursor"
}