*REST API › Endpoint reference › Platform › 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.

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

`GET /api/v1/workflows` — scope `workflows:read`

Scope: `workflows:read` · 120/min · Strict tenancy · MCP: `filmo_workflows_list`

## Authorizations

Bearer API key with the scope below. `workflows:read`

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | integer | No | Page size (1-500). Defaults to 50. = `50` |
| `cursor` | string | No | Opaque cursor of the page to return. Pass the value of `pagination.nextCursor` from the previous response; treat it as opaque. |
| `createdOn` | string | No | The creation date of the resource falls on this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `createdAfter` | string | No | The creation date of the resource is after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `createdBefore` | string | No | The creation date of the resource is before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `createdFrom` | string | No | The creation date of the resource is on or after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `createdTo` | string | No | The creation date of the resource is on or before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `updatedOn` | string | No | The last update date of the resource falls on this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `updatedAfter` | string | No | The last update date of the resource is after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `updatedBefore` | string | No | The last update date of the resource is before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `updatedFrom` | string | No | The last update date of the resource is on or after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `updatedTo` | string | No | The last update date of the resource is on or before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `sort` | string | No | 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. |
| `isActive` | boolean | No | Filter by whether the workflow is active (true) or paused (false). |
| `triggerType` | string | No | Filter by how the workflow starts: manual, schedule, webhook, event, signal or entity. `manual`, `schedule`, `webhook`, `event`, `signal`, `entity` |
| `triggerTypes` | string[] | No | 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. `manual`, `schedule`, `webhook`, `event`, `signal`, `entity` |
| `includeTotal` | boolean | No | Set it to true to include `pagination.total`, the number of results that match the filters across all pages. Off by default. = `false` |

## Request examples

*List workflows*

**cURL**

```bash
curl https://app.filmo.io/api/v1/workflows \
  --header "Authorization: Bearer $FILMO_API_KEY"
```

**Node.js**

```javascript
fetch('https://app.filmo.io/api/v1/workflows', {
  headers: {
    Authorization: 'Bearer YOUR_FILMO_API_KEY'
  }
})
```

**Python**

```python
import requests

requests.get("https://app.filmo.io/api/v1/workflows",
    headers={
      "Authorization": "Bearer YOUR_FILMO_API_KEY"
    }
)
```

## Response

Response schema: `WorkflowDto`

| Status | Description |
| --- | --- |
| 200 | Successful response. |
| 400 | Invalid request (validation_error): malformed query or body. `errors[]` lists every offending field with its stable code. |
| 401 | Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin). |
| 403 | Not allowed (insufficient_scope: the API key does not have the required scope, named in `requiredScope`; forbidden: the owner of the key lacks the permission the operation requires). `insufficient_scope` is answered before the request counts against the rate limit, so it carries no `RateLimit-*` headers; `forbidden` does. |
| 429 | Rate limit exceeded (rate_limited): retry after `Retry-After` seconds; `RateLimit-*` says which quota ran out. |
| 500 | Internal error (internal_error). |

**200**

| Name | Type | Description |
| --- | --- | --- |
| `data` | object[] |  |
| `data.id` | string | Unique identifier of the workflow. |
| `data.name` | string | Workflow name. |
| `data.isActive` | boolean | true when the workflow is active; false when it is paused. |
| `data.archivedAt` | string<date-time> | Date it was archived in ISO 8601 UTC; null if it is not archived. |
| `data.trigger` | object | How the workflow starts and, if manual, what it asks for. |
| `data.trigger.type` | string | 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. `manual`, `schedule`, `webhook`, `event`, `signal`, `entity` |
| `data.trigger.event` | string | For `event` triggers, the Filmo event it listens to; null otherwise. |
| `data.trigger.entity` | string | For `entity` triggers, the entity type it runs on; null otherwise. |
| `data.trigger.form` | object[] | For `manual` triggers, the run form: every field listed is REQUIRED in `payload` when calling [`POST /api/v1/workflows/{workflowId}/runs`](https://docs.filmo.io/rest-api/endpoint-reference/workflows/run-a-workflow). Empty when the workflow asks nothing. |
| `data.trigger.form.name` | string | Key of the field in `payload` when running the workflow. |
| `data.trigger.form.label` | string | Label shown to the person who runs it. |
| `data.trigger.form.type` | object<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. |
| `data.currentVersion` | object | 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. |
| `data.currentVersion.version` | integer | Number of the published version. |
| `data.currentVersion.createdAt` | string<date-time> | When it was published, in ISO 8601 UTC. |
| `data.createdAt` | string<date-time> | Creation date in ISO 8601 UTC. |
| `data.updatedAt` | string<date-time> | Last modification date in ISO 8601 UTC. |
| `pagination` | object | Opaque-cursor pagination metadata. |
| `pagination.nextCursor` | string | Opaque cursor of the next page; null when there are no more results. Pass it as `cursor` in the next request. |
| `pagination.hasMore` | boolean | Whether more results exist beyond this page. |
| `pagination.total` | integer | Number of results matching the filters across all pages. Present only when the request sets `includeTotal=true`. |
| `meta` | object | Additional information about the response. |
| `meta.warnings` | object[] | Lifecycle warnings; present only when the operation is deprecated. |
| `meta.warnings.code` | string | Stable warning code. `deprecated` |
| `meta.warnings.message` | string | For people: what is deprecated, until when, and what to use. |
| `meta.warnings.sunset` | string | Day (YYYY-MM-DD) the operation stops being served. |
| `meta.warnings.replacement` | string | `operationId` of the operation to use instead, or null if there is none. |
| `meta.warnings.link` | string | Where the deprecation is documented (the changelog). |

*Example response · 200*

```json
{
  "data": [
    {
      "id": "workflow_9f3a2b",
      "name": "Example workflow",
      "isActive": true,
      "archivedAt": "2026-09-01T08:00:00.000Z",
      "trigger": {
        "type": "manual",
        "event": "Example event",
        "entity": "Example entity",
        "form": [
          {
            "name": "Example form",
            "label": "Main",
            "type": {
              "example": "example"
            }
          }
        ]
      },
      "currentVersion": {
        "version": 1,
        "createdAt": "2026-09-01T08:00:00.000Z"
      },
      "createdAt": "2026-09-01T08:00:00.000Z",
      "updatedAt": "2026-09-01T08:00:00.000Z"
    }
  ],
  "pagination": {
    "nextCursor": "eyJvIjoyMH0",
    "hasMore": true,
    "total": 1
  }
}
```

## Errors

| Status | Codes | Meaning |
| --- | --- | --- |
| 400 | `validation_error` | Malformed query or body. `errors[]` lists every offending field with its stable code. |

## Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date.

---

Canonical URL: https://docs.filmo.io/rest-api/endpoint-reference/workflows/list-workflows  
Last updated: 2026-10-25