Workflows
List workflows
Returns the workflows of the account with how each one starts and, for manual ones, the run form: the fields POST /api requires in payload, read from the published version.
workflows:readworkflows:read- 120/min
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
It emits no definition. Administrators only. Sorted by name.
Arguments
Page size (1-500). Defaults to 50.
Limits: min 1, max 500
Opaque cursor of the page to return. Pass the value of pagination. from the previous response; treat it as opaque.
Limits: max length 200
Sort order: up to 3 comma-separated fields, each with a leading "-" for descending (e.g. "-updatedAt,name"). Sortable fields: name, isActive, triggerType, createdAt, updatedAt. Defaults to "name". Ties are broken by id, so the order is stable across pages, and a cursor is bound to the sort it was issued with.
Limits: max length 200
Filter by whether the workflow is active (true) or paused (false).
Filter by how the workflow starts: manual, schedule, webhook, event, signal or entity.
Available options: manual, schedule, webhook, event, signal, entity
Filter by triggerType, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.
Available options: manual, schedule, webhook, event, signal, entity
Limits: min 1 items, max 50 items
Set it to true to include pagination., the number of results that match the filters across all pages. Off by default.
Date filters by field. A bare day (YYYY-MM-DD) is read in the business timezone; an ISO 8601 instant with offset is applied as is by gte, lte, gt and lt, while on widens it to the whole business day that contains it. Fields: created, updated.
Show child attributesHide child attributes
Show child attributesHide child attributes
From this day or instant, inclusive.
Up to this day or instant, inclusive.
Strictly after; a bare day means after the end of that day.
Strictly before; a bare day means before the start of that day.
Exactly that day; an instant means the whole business day that contains it.
Show child attributesHide child attributes
From this day or instant, inclusive.
Up to this day or instant, inclusive.
Strictly after; a bare day means after the end of that day.
Strictly before; a bare day means before the start of that day.
Exactly that day; an instant means the whole business day that contains it.
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
Show the attributes of data
Unique identifier of the workflow.
Workflow name.
true when the workflow is active; false when it is paused.
Date it was archived in ISO 8601 UTC; null if it is not archived.
How the workflow starts and, if manual, what it asks for.
Show child attributesHide child attributes
How the workflow starts: manual (a person or the API runs it), schedule (cron), webhook (an incoming request), event (something happens in Filmo), signal (another workflow) or entity (run from the page of a record). Null if it has no published version.
Available options: manual, schedule, webhook, event, signal, entity
For event triggers, the Filmo event it listens to; null otherwise.
For entity triggers, the entity type it runs on; null otherwise.
For manual triggers, the run form: every field listed is REQUIRED in payload when calling POST /api. Empty when the workflow asks nothing.
Show child attributesHide child attributes
Key of the field in payload when running the workflow.
Label shown to the person who runs it.
Declared type of the value, in the workflow type language: {"type":"string"}, {"type":"number"}, {"type":"boolean"}, {"type":"date","mode":"date"|"datetime"}, {"type":"enum","options":[{"value","label"}]}, {"type":"shape","shape":[{"key","label","value":<type>}]}, {"type":"list","item":<type>}, {"type":"record","value":<type>} or {"type":"tuple","tuple":[<type>]}. The value sent in payload is validated against it.
The published version, which is the one that runs and the one the run form is read from; null when the workflow has never been saved.
Show child attributesHide child attributes
Number of the published version.
When it was published, in ISO 8601 UTC.
Creation date in ISO 8601 UTC.
Last modification date in ISO 8601 UTC.
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
Sample prompts
Which workflows can I run from here?
The same operation by REST
This tool runs GET /api/v1/workflows.
Related pages
Link to this section: Related pagesWorkflows
List workflows
Returns the workflows of the account with how each one starts and, for manual ones, the run form: the fields
POST /apirequires in/v1 /workflows /{workflowId} /runs payload, read from the published version.Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with
isError: trueand the problem in the first text block. Branch on itscode.
Was this page helpful?