Skip to main content
GET
List automations in the workspace.

Authorizations

x-api-key
string
header
required

Your workspace API key. It both authenticates the caller and selects the workspace.

Query Parameters

status
string

Filter by automation status. One of: draft, active, paused, failed.

type
string

Filter by the trigger type that starts the automation (AutomationType value), e.g. whatsapp_message, contact_created, invoice_paid, appointment_booked.

builder
string

Filter by how the automation was authored. One of: quick (static form), flow (visual canvas).

channel
string

Filter to automations bound to a specific channel, identified by the channel's uuid.

per_page
integer

Items per page (alias: limit). Default 25, maximum 100.

Response

A paginated list.

A paginated collection. per_page defaults to 25 and is capped at 100.

data
object[]
meta
object