> ## Documentation Index
> Fetch the complete documentation index at: https://help.statisfy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List flows

> Lists the workspace's flows, the latest change first, each with its trigger. Filter with `name` (contains), `enabled`, `trigger` and `folder`. A flow is an automation from Agent Studio's Automations tab: a trigger (what starts it) and the steps it runs. Deleted flows and saved components are not listed.



## OpenAPI

````yaml /api/statisfy-api.openapi.json get /v1/automations/flows
openapi: 3.1.0
info:
  description: >-
    The agent-first Statisfy API. Authenticate with an API key (`Authorization:
    Bearer stfy_live_…`), then call `GET /v1/meta/capabilities` to discover
    every operation and its schemas.
  title: Statisfy API
  version: 1.0.0
servers:
  - url: https://api.statisfy.com
    description: Production
security: []
paths:
  /v1/automations/flows:
    get:
      tags:
        - automations
      summary: List flows
      description: >-
        Lists the workspace's flows, the latest change first, each with its
        trigger. Filter with `name` (contains), `enabled`, `trigger` and
        `folder`. A flow is an automation from Agent Studio's Automations tab: a
        trigger (what starts it) and the steps it runs. Deleted flows and saved
        components are not listed.
      operationId: automations_list_flows
      parameters:
        - in: query
          name: limit
          required: false
          schema:
            default: 25
            maximum: 100
            minimum: 1
            type: integer
        - description: '`next_cursor` from the previous page'
          in: query
          name: cursor
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            default: null
        - description: Only flows whose name contains this, ignoring case
          in: query
          name: name
          required: false
          schema:
            anyOf:
              - maxLength: 255
                minLength: 1
                type: string
              - type: 'null'
            default: null
        - description: Only flows that are on (true) or off (false)
          in: query
          name: enabled
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
            default: null
        - description: Only flows with this trigger type
          in: query
          name: trigger
          required: false
          schema:
            anyOf:
              - enum:
                  - schedule
                  - segment
                  - field_change
                  - new_activity
                  - meeting_processed
                  - upcoming_meeting
                  - warehouse_data
                type: string
              - type: 'null'
            default: null
        - description: Only flows in the folder with this name
          in: query
          name: folder
          required: false
          schema:
            anyOf:
              - maxLength: 255
                type: string
              - type: 'null'
            default: null
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlowPage'
          description: Successful Response
      security:
        - HTTPBearer: []
components:
  schemas:
    FlowPage:
      properties:
        data:
          items:
            $ref: '#/components/schemas/Flow'
          title: Data
          type: array
        has_more:
          default: false
          title: Has More
          type: boolean
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
      required:
        - data
      title: FlowPage
      type: object
    Flow:
      properties:
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        enabled:
          description: Whether the flow is on
          title: Enabled
          type: boolean
        folder:
          anyOf:
            - type: string
            - type: 'null'
          description: The Agent Studio folder it is in
          title: Folder
        id:
          title: Id
          type: string
        name:
          title: Name
          type: string
        trigger:
          anyOf:
            - $ref: '#/components/schemas/Trigger'
            - type: 'null'
          description: What starts it; null for a flow with no trigger step
        updated_at:
          anyOf:
            - type: string
            - type: 'null'
          description: ISO 8601 UTC
          title: Updated At
      required:
        - id
        - name
        - description
        - enabled
        - folder
        - trigger
        - updated_at
      title: Flow
      type: object
    Trigger:
      properties:
        object:
          anyOf:
            - enum:
                - account
                - contact
                - opportunity
                - project
                - task
                - user
                - activity
                - meeting
              type: string
            - type: 'null'
          description: The record it runs on; null for a schedule or warehouse data
          title: Object
        type:
          description: What starts the flow
          enum:
            - schedule
            - segment
            - field_change
            - new_activity
            - meeting_processed
            - upcoming_meeting
            - warehouse_data
          title: Type
          type: string
      required:
        - type
        - object
      title: Trigger
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http
      description: >-
        An API key, sent as `Authorization: Bearer stfy_live_…`. See
        [Authentication](/rest-api/authentication) for how to get one and which
        scopes it needs.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.