Rule.io SDK

---

Rule.io SDK / client/src / ListAutomationsParams

Interface: ListAutomationsParams

Defined in: client/src/resources/automations/automations.types.ts:279

Parameters for AutomationsClient.listAutomations and the auto-pagination helpers (AutomationsClient.iterateAutomations, AutomationsClient.iterateAutomationsPages, AutomationsClient.listAllAutomations).

Example

// List active email automations
const page = await client.automations.listAutomations({
  filters: { active: true, messageType: 'email' },
  pagination: { page: 1, pageSize: 20 },
});

Properties

filters?

optional filters?: object

Defined in: client/src/resources/automations/automations.types.ts:281

active?

optional active?: boolean

Filter to only active or only inactive automations.

messageType?

optional messageType?: "email" | "text_message"

Filter by message type.

'email' = email automations, 'text_message' = SMS automations.

query?

optional query?: string

Full-text search by automation name.

---

pagination?

optional pagination?: PagePaginationParams

Defined in: client/src/resources/automations/automations.types.ts:280