Skip to content
Micro micro
Go to Micro
API Reference
Triggered Automations

List triggered automations for an owner

triggered_automations.list(Literal["message", "action", "event", 6 more]automation_object_type, TriggeredAutomationListParams**kwargs) -> TriggeredAutomationListResponse
GET/v2/prism/{teamId}/{automationObjectType}/triggered_automations

List triggered automations for an owner

ParametersExpand Collapse
team_id: Optional[str]
formatuuid
automation_object_type: Literal["message", "action", "event", 6 more]

Object types that support triggered automations. Must match the triggered-automation whitelist in @micro/database migrate-sql (TRIGGERED_AUTOMATION_OBJECTS).

One of the following:
"message"
"action"
"event"
"document"
"identity"
"linkedin_message"
"deal"
"organization"
"contact"
cursor: Optional[str]

Opaque pagination cursor (from a prior response’s next_cursor); supersedes page/limit when present.

kind: Optional[Literal["update", "lifecycle"]]

Optional filter to a single automation kind. When omitted, both kinds are returned.

One of the following:
"update"
"lifecycle"
limit: Optional[int]

Maximum items per page (<= 50; defaults to 50).

minimum0
maximum50
list_id: Optional[str]

List (CRM) id to scope the listing to. When omitted, automations owned by the path team are returned.

formatuuid
page: Optional[int]

1-based page number. Prefer cursor.

minimum1
ReturnsExpand Collapse
class TriggeredAutomationListResponse: …
kind: Literal["update", "lifecycle"]
One of the following:
"update"
"lifecycle"
name: str
id: Optional[str]
formatuuid
actions: Optional[List[Action]]

Actions to run when the automation fires; each item has a type plus type-specific fields.

type: Literal["agent", "webhook", "wait", 2 more]
One of the following:
"agent"
"webhook"
"wait"
"email"
"linkedin"
agent_id: Optional[str]

Required when type is agent. The agent to run.

formatuuid
cron_expression: Optional[str]

wait: cron schedule for the resume time. Exactly one of delay_seconds or cron_expression.

delay_seconds: Optional[int]

wait: relative delay in seconds. Exactly one of delay_seconds or cron_expression.

recipient_email_prop_def_id: Optional[str]

Required when type is email. The property (on the recipient view object) holding the recipient email address.

formatuuid
recipient_provider_prop_def_id: Optional[str]

Required when type is linkedin. The property (on the recipient view object) holding the recipient LinkedIn provider id.

formatuuid
recipient_view_id: Optional[str]

Required when type is email or linkedin. The saved prism view resolved at send time to the recipient audience (its filter re-runs each step, so responders drop out of later drip sends).

formatuuid
recipient_view_object_type: Optional[str]

Required when type is email or linkedin. Must be contact — the recipient audience is a contact view (contacts carry the direct email / linkedin provider property).

send_as_user_id: Optional[str]

Required when type is email or linkedin. The user (external id) the message is sent as.

subject: Optional[str]

Required when type is email. The subject line; rendered as a Liquid template per recipient.

template_id: Optional[str]

Required when type is email or linkedin. The email-template document whose body is rendered (Liquid) per recipient.

formatuuid
timezone: Optional[str]

wait: IANA timezone for evaluating cron_expression (optional).

webhook_id: Optional[str]

Required when type is webhook. The id of the webhook the event is dispatched to (async) when the automation fires.

formatuuid
changeset: Optional[Changeset]

A changeset filter group (update automations only): a combinator plus an array of transition clauses matching what is changing. Dot-paths (nested reference filters) are NOT permitted — direct properties only.

combinator: Optional[Literal["AND", "OR"]]
One of the following:
"AND"
"OR"
filter: Optional[List[Dict[str, object]]]

Each entry is a transition clause { slug: { from?: { comparator: value }, to?: { comparator: value } } }. from matches the prior value, to the new value; an empty body { slug: {} } matches any change to that property.

created_at: Optional[str]
enabled: Optional[bool]
list_id: Optional[str]
formatuuid
on_create: Optional[bool]

Lifecycle automations only.

on_delete: Optional[bool]

Lifecycle automations only.

state: Optional[State]

A filter group: a combinator plus an array of slug-based clauses. Dot-paths (e.g. organization.location) express nested reference filters.

combinator: Optional[Literal["AND", "OR"]]
One of the following:
"AND"
"OR"
filter: Optional[List[Dict[str, object]]]

Each entry is { slug: { comparator: value } }

team_id: Optional[str]
formatuuid
updated_at: Optional[str]
user_id: Optional[str]
has_more: bool

True if more automations exist beyond this page.

next_cursor: Optional[str]

Opaque cursor for the next page; null when has_more is false.

List triggered automations for an owner

import os
from micro_so import Micro

client = Micro(
    api_key=os.environ.get("MICRO_API_KEY"),  # This is the default and can be omitted
)
triggered_automations = client.triggered_automations.list(
    automation_object_type="message",
)
print(triggered_automations.data)
{
  "data": [
    {
      "kind": "update",
      "name": "name",
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "actions": [
        {
          "type": "agent",
          "agent_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "cron_expression": "cron_expression",
          "delay_seconds": 0,
          "recipient_email_prop_def_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "recipient_provider_prop_def_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "recipient_view_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "recipient_view_object_type": "recipient_view_object_type",
          "send_as_user_id": "send_as_user_id",
          "subject": "subject",
          "template_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "timezone": "timezone",
          "webhook_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        }
      ],
      "changeset": {
        "combinator": "AND",
        "filter": [
          {
            "foo": "bar"
          }
        ]
      },
      "created_at": "created_at",
      "enabled": true,
      "list_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "on_create": true,
      "on_delete": true,
      "state": {
        "combinator": "AND",
        "filter": [
          {
            "foo": "bar"
          }
        ]
      },
      "team_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "updated_at": "updated_at",
      "user_id": "user_id"
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}
Returns Examples
{
  "data": [
    {
      "kind": "update",
      "name": "name",
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "actions": [
        {
          "type": "agent",
          "agent_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "cron_expression": "cron_expression",
          "delay_seconds": 0,
          "recipient_email_prop_def_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "recipient_provider_prop_def_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "recipient_view_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "recipient_view_object_type": "recipient_view_object_type",
          "send_as_user_id": "send_as_user_id",
          "subject": "subject",
          "template_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "timezone": "timezone",
          "webhook_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        }
      ],
      "changeset": {
        "combinator": "AND",
        "filter": [
          {
            "foo": "bar"
          }
        ]
      },
      "created_at": "created_at",
      "enabled": true,
      "list_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "on_create": true,
      "on_delete": true,
      "state": {
        "combinator": "AND",
        "filter": [
          {
            "foo": "bar"
          }
        ]
      },
      "team_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "updated_at": "updated_at",
      "user_id": "user_id"
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}