v1

latestOpenAPI 3.1.02026-07-2670105729.6 KB
Automations

Get automations

Unified automation read. Omit automationId to LIST the brand’s automations under { data, pagination } — list rows are LEAN (graph omitted). Pass ?automationId= to fetch ONE — returns { data: [row] } (no pagination), 404 AUTOMATION_NOT_FOUND on an unknown / cross-brand id, also LEAN by default. Add detail-only ?include=graph (the full nodes + connections) and/or ?include=versions (lean { version, automationVersionId } history) — both rejected without automationId.

get/v1/automations

Query parameters

automationIdstring

Fetch a single automation by id (detail mode → { data: [row] }). Omit to list.

includestring
Example:graph,versions

Detail-only expansions (comma-separated): graph inlines nodes/connections; versions inlines the lean version history. Rejected without automationId.

limitinteger

Page size (1–100). Defaults to 100.

cursorstring

Opaque pagination cursor echoed from the previous page’s pagination.cursor. Omit for the first page.

Response

A page of lean automation rows (list mode), or { data: [row] } (detail mode).