# List flows

`GET` `/api/v1/crm-connections/{crm_connection_id}/flows`

Return flow definitions from the connected Salesforce org.
Optionally search by label. Supports sorting and
cursor-based pagination. Default page size is 50. Pass next_records_url
from one response into the next request to paginate through large result sets.

## Path parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| crm_connection_id | string | yes | UUID of the CRM connection |

## Query parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| query | string | no | Search by flow label (min 2 characters) |
| trigger_object | string | no | Filter by trigger object or event label (exact match, e.g. Opportunity, Account). |
| process_type | string | no | Filter by flow process type (exact match, e.g. Flow, AutoLaunchedFlow, Workflow). |
| is_active | string | no | Filter by active status. true returns only flows with an active version; false returns only flows with no active version. Omit to return all flows regardless of active status. |
| is_template | string | no | Filter by template status. true returns only template flows; false returns only non-template flows. Omit to return all flows regardless of template status. |
| sort_by | string | no | Field to sort by (default: Label) |
| sort_direction | string | no | Sort direction: ASC (default) or DESC |
| limit | string | no | Maximum number of flows to return (default: 50). |
| next_records_url | string | no | Cursor returned by a previous response to fetch the next page. When provided, all other query params are ignored. |

## Response

`200 OK` — `application/json`

| Field | Type | Description |
|-------|------|-------------|
| flows | array[object] | List of flow definition records |
| flows.id | string | Flow definition ID |
| flows.api_name | string | API name of the flow |
| flows.label | string | Display label of the flow |
| flows.description | string | Description of the flow |
| flows.active_version_id | string | ID of the active flow version, or null if there is no active version |
| flows.latest_version_id | string | ID of the most recently saved flow version |
| flows.version_number | integer | Version number of the latest flow version |
| flows.is_active | boolean | Whether the flow has an active version |
| flows.is_out_of_date | boolean | Whether the active version is older than the most recently saved version |
| flows.is_template | boolean | Whether the flow is a template |
| flows.is_overridable | boolean | Whether the flow can be overridden by a subscriber org |
| flows.is_swing_flow | boolean | Whether the flow was built with the legacy Swing Designer |
| flows.process_type | string | Type of flow (e.g. Flow, AutoLaunchedFlow, Workflow, InvocableProcess) |
| flows.record_trigger_type | string | Trigger condition for record-triggered flows (e.g. Create, Update, CreateAndUpdate, Delete) |
| flows.trigger_type | string | Trigger type for the flow (e.g. RecordBeforeSave, RecordAfterSave, Scheduled, PlatformEvent) |
| flows.trigger_object_or_event_id | string | ID of the object or platform event that triggers the flow |
| flows.trigger_object_or_event_label | string | Label of the object or platform event that triggers the flow |
| flows.trigger_order | integer | Execution order relative to other record-triggered flows on the same object and trigger event |
| flows.builder | string | Tool used to create the flow (e.g. Flow Builder, Cloud Flow Designer) |
| flows.api_version | number | API version the flow was saved with |
| flows.last_modified_by | string | Name of the user who last modified the flow |
| flows.installed_package_name | string | Name of the managed package that installed this flow, if any |
| flows.manageable_state | string | Managed package state of the package component. One of: Active, Deleted, Deprecated, DeprecatedEditable, Installed, InstalledEditable, Released, Unmanaged |
| flows.namespace_prefix | string | Namespace prefix of the component's package, if any |
| flows.durable_id | string | Stable identifier for the flow definition across versions |
| flows.source_template_id | string | ID of the template this flow was created from, if any |
| flows.overridden_by_id | string | ID of the flow that overrides this one in a subscriber org, if any |
| flows.overridden_flow_id | string | ID of the flow being overridden by this one, if any |
| next_records_url | string | Pass this value as next_records_url on the next request to fetch the following page. Null when all records have been returned. Only present when limit exceeds Salesforce's per-page maximum (2000 records). |

## Errors

| Status | Description |
|--------|-------------|
| 400 | Bad Request |
| 403 | Forbidden |
| 404 | Not Found |
| 422 | Unprocessable Entity |
| 502 | Bad Gateway |