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/v1/workflows/{workflowId}/runs requires in payload, read from the published version.

Tool
filmo_workflows_list
Access: Read

Result

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_workflows_list",
    "arguments": {
      "limit": 20
    }
  }
}

generated from the schema

It emits no definition. Administrators only. Sorted by name.

Arguments

limitintegerdefault:50

Page size (1-500). Defaults to 50.

Limits: min 1, max 500

cursorstring

Opaque cursor of the page to return. Pass the value of pagination.nextCursor from the previous response; treat it as opaque.

Limits: max length 200

sortstring

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

isActiveboolean

Filter by whether the workflow is active (true) or paused (false).

triggerTypestring

Filter by how the workflow starts: manual, schedule, webhook, event, signal or entity.

Available options: manual, schedule, webhook, event, signal, entity

triggerTypesstring[]

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

includeTotalbooleandefault:false

Set it to true to include pagination.total, the number of results that match the filters across all pages. Off by default.

dateFiltersobject

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 attributes
dateFilters.createdobject

Show child attributes
dateFilters.created.gtestring

From this day or instant, inclusive.

dateFilters.created.ltestring

Up to this day or instant, inclusive.

dateFilters.created.gtstring

Strictly after; a bare day means after the end of that day.

dateFilters.created.ltstring

Strictly before; a bare day means before the start of that day.

dateFilters.created.onstring

Exactly that day; an instant means the whole business day that contains it.

dateFilters.updatedobject

Show child attributes
dateFilters.updated.gtestring

From this day or instant, inclusive.

dateFilters.updated.ltestring

Up to this day or instant, inclusive.

dateFilters.updated.gtstring

Strictly after; a bare day means after the end of that day.

dateFilters.updated.ltstring

Strictly before; a bare day means before the start of that day.

dateFilters.updated.onstring

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
idstring

Unique identifier of the workflow.

namestring

Workflow name.

isActiveboolean

true when the workflow is active; false when it is paused.

archivedAtstring<date-time> | null

Date it was archived in ISO 8601 UTC; null if it is not archived.

triggerobject

How the workflow starts and, if manual, what it asks for.

Show child attributes
trigger.typestring | null

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

trigger.eventstring | null

For event triggers, the Filmo event it listens to; null otherwise.

trigger.entitystring | null

For entity triggers, the entity type it runs on; null otherwise.

trigger.formobject[]

For manual triggers, the run form: every field listed is REQUIRED in payload when calling POST /api/v1/workflows/{workflowId}/runs. Empty when the workflow asks nothing.

Show child attributes
trigger.form.namestring

Key of the field in payload when running the workflow.

trigger.form.labelstring

Label shown to the person who runs it.

trigger.form.typeobject<string, any>

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.

currentVersionobject | null

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 attributes
currentVersion.versioninteger

Number of the published version.

currentVersion.createdAtstring<date-time>

When it was published, in ISO 8601 UTC.

createdAtstring<date-time>

Creation date in ISO 8601 UTC.

updatedAtstring<date-time>

Last modification date in ISO 8601 UTC.

An error is a result with isError: true and the problem in content[0].text; 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.

  • 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/v1/workflows/{workflowId}/runs requires in 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: true and the problem in the first text block. Branch on its code.