> ## Documentation Index
> Fetch the complete documentation index at: https://flows-docs.edges.run/llms.txt
> Use this file to discover all available pages before exploring further.

# List Flow Runs

> Retrieve a list of flow runs with filtering and pagination options

List all flow runs in your workspace with support for filtering, sorting, and pagination.
This endpoint is useful for monitoring flow execution history, finding specific runs, or building dashboards.

**Use Cases**:

* Monitor all flow runs across your workspace
* Filter runs by status to find completed, failed, or running flows
* Track runs by specific users or workspaces
* Find specific runs by their UID

**Examples**:

<AccordionGroup>
  <Accordion title="List recent successful runs">
    ```bash theme={null}
    curl --request GET \
      --url 'https://api.edges.run/v1/flows/runs?status=SUCCEEDED&limit=20&sort=-created_at' \
      --header 'X-API-Key: <your-api-key>'
    ```
  </Accordion>

  <Accordion title="Find specific runs by UID">
    ```bash theme={null}
    curl --request GET \
      --url 'https://api.edges.run/v1/flows/runs?uid=550e8400-e29b-41d4-a716-446655440000&uid=660e8400-e29b-41d4-a716-446655440001' \
      --header 'X-API-Key: <your-api-key>'
    ```
  </Accordion>

  <Accordion title="Paginate through all runs">
    ```bash theme={null}
    # First page
    curl --request GET \
      --url 'https://api.edges.run/v1/flows/runs?limit=50&offset=0' \
      --header 'X-API-Key: <your-api-key>'

    # Second page
    curl --request GET \
      --url 'https://api.edges.run/v1/flows/runs?limit=50&offset=50' \
      --header 'X-API-Key: <your-api-key>'
    ```
  </Accordion>

  <Accordion title="Monitor running flows">
    ```bash theme={null}
    curl --request GET \
      --url 'https://api.edges.run/v1/flows/runs?status=RUNNING&status=QUEUED' \
      --header 'X-API-Key: <your-api-key>'
    ```
  </Accordion>
</AccordionGroup>


## OpenAPI

````yaml GET /flows/runs
openapi: 3.1.0
info:
  title: ED Automation Flows API
  description: This is the Flows API documentation for ED Automation
  version: dev
servers:
  - url: https://api.edges.run/v1
security:
  - XApiKeyAuth: []
paths:
  /flows/runs:
    get:
      tags:
        - flows
      summary: Get flow runs
      operationId: getFlowRuns
      parameters:
        - schema:
            type: array
            items:
              type: string
              enum:
                - CREATED
                - INVALID
                - QUEUED
                - SCHEDULED
                - BLOCKED
                - STOPPED
                - RUNNING
                - FAILED
                - PARTIAL_SUCCEEDED
                - SUCCEEDED
            minItems: 1
            nullable: true
          in: query
          name: status
          required: false
        - schema:
            type: array
            items:
              type: string
              format: uuid
            minItems: 1
            nullable: true
          in: query
          name: uid
          required: false
        - schema:
            type: array
            items:
              type: string
              format: uuid
            minItems: 1
            nullable: true
          in: query
          name: user_uid
          required: false
        - schema:
            type: array
            items:
              type: string
              format: uuid
            minItems: 1
            nullable: true
          in: query
          name: flow_preset_uid
          required: false
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
          in: query
          name: limit
          required: false
        - schema:
            type: integer
            minimum: 0
            default: 0
          in: query
          name: offset
          required: false
        - schema:
            type: array
            items:
              type: string
              maxLength: 128
            default:
              - created_at
            maxItems: 10
          examples:
            example1:
              value:
                - '-created_at, status'
            example2:
              value:
                - '-created_at'
                - status
            example3:
              value:
                - updated_at
          in: query
          name: sort
          required: false
          description: >-
            Sort by fields. Prefix with `-` for descending order. Default is
            ascending order.
      responses:
        '200':
          description: Returns the flow runs
          content:
            application/json:
              schema:
                description: Returns the flow runs
                type: array
                items:
                  type: object
                  properties:
                    uid:
                      type: string
                      format: uuid
                      description: Flow Run UUID
                    user_uid:
                      type: string
                      format: uuid
                      description: Member/User UUID
                    workspace_uid:
                      type: string
                      format: uuid
                      description: Workspace UUID
                    last_error:
                      type: object
                      description: Last error message
                      properties:
                        label:
                          type: string
                          description: Label
                        message:
                          type: string
                          description: Message
                      nullable: true
                    callback:
                      type: object
                      description: Callback
                      properties:
                        url:
                          type: string
                          description: Callback URL
                      nullable: true
                    status:
                      type: string
                      description: Flow Run status
                      enum:
                        - CREATED
                        - INVALID
                        - QUEUED
                        - SCHEDULED
                        - BLOCKED
                        - STOPPED
                        - RUNNING
                        - FAILED
                        - PARTIAL_SUCCEEDED
                        - SUCCEEDED
                      nullable: true
                    output_count:
                      type: integer
                      description: >-
                        Number of outputs generated by the flow run (only
                        available when the flow run is finished)
                      default: 0
                      nullable: true
                    scheduled_flow_run_uid:
                      type: string
                      format: uuid
                      description: >-
                        If the flow run is scheduled, this field indicates the
                        scheduled flow run UUID.
                      nullable: true
                    started_at:
                      type: string
                      description: Started at
                      nullable: true
                    finished_at:
                      type: string
                      description: Finished at
                      nullable: true
                    created_at:
                      type: string
                      description: Created at
                    updated_at:
                      type: string
                      description: Updated at
                      nullable: true
                  additionalProperties: false
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/def-0'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/def-0'
components:
  schemas:
    def-0:
      title: APIError
      description: >-
        Represents an error returned by the API. This schema defines the
        standard structure of error messages to ensure consistent error handling
        across the application.
      type: object
      properties:
        error_label:
          type: string
          nullable: true
        error_scope:
          type: string
          enum:
            - input
            - integ
            - param
            - config
          nullable: true
        error_ref:
          type: string
          nullable: true
          example: ERR-12345
        message:
          type: string
        status_code:
          type: integer
          nullable: true
        params:
          type: object
          additionalProperties:
            anyOf:
              - type: string
              - type: number
              - type: boolean
              - type: 'null'
              - type: array
                items:
                  type: string
          nullable: true
        data:
          type: object
          nullable: true
          additionalProperties: true
          description: Additional data about the error
      additionalProperties: false
  securitySchemes:
    XApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````