> ## 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 Scheduled Flows
> Get a list of all scheduled flow runs
Retrieve a list of all scheduled flow runs in your workspace. You can filter by status, user, flow preset, and more.
## Examples
```bash theme={null}
curl --request GET \
--url 'https://api.edges.run/v1/flows/schedules?status=ACTIVE' \
--header 'X-API-Key: '
```
```bash theme={null}
curl --request GET \
--url 'https://api.edges.run/v1/flows/schedules?flow_preset_slug=linkedin-people-enrich&status=ACTIVE' \
--header 'X-API-Key: '
```
```bash theme={null}
curl --request GET \
--url 'https://api.edges.run/v1/flows/schedules?limit=50&offset=0&sort=-next_execution_at' \
--header 'X-API-Key: '
```
This returns 50 schedules sorted by next execution time (soonest first).
```bash theme={null}
curl --request GET \
--url 'https://api.edges.run/v1/flows/schedules?limit=20&sort=-created_at' \
--header 'X-API-Key: '
```
## Schedule Statuses
| Status | Description |
| ----------- | --------------------------------------------------------- |
| `ACTIVE` | Schedule is active and will execute at the scheduled time |
| `PAUSED` | Schedule is paused and will not execute |
| `CANCELLED` | Schedule has been cancelled and will not execute again |
| `COMPLETED` | One-time schedule that has already executed |
Use the `uid` from the list response to get detailed information about a specific schedule with [Get Schedule](/api/schedules/get) or to manage it with [Manage Schedule](/api/schedules/manage).
## OpenAPI
````yaml GET /flows/schedules
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/schedules:
get:
tags:
- flows / schedules
summary: Get the scheduled flow_runs
parameters:
- schema:
type: array
items:
type: string
format: uuid
minItems: 1
nullable: true
in: query
name: uid
required: false
description: Scheduled flow_run UUID
- schema:
type: array
items:
type: string
enum:
- ACTIVE
- CANCELLED
- PAUSED
- COMPLETED
minItems: 1
nullable: true
in: query
name: status
required: false
description: Scheduled flow_run status
- schema:
type: array
items:
type: string
format: uuid
minItems: 1
nullable: true
in: query
name: user_uid
required: false
description: User UUID
- schema:
type: array
items:
type: string
format: uuid
minItems: 1
nullable: true
in: query
name: workspace_uid
required: false
description: Workspace UUID
- schema:
type: array
items:
type: string
minItems: 1
nullable: true
in: query
name: flow_preset_slug
required: false
description: Flow preset slug
- schema:
type: array
items:
type: string
format: date-time
minItems: 1
nullable: true
in: query
name: next_execution_at
required: false
description: Next execution at
- schema:
type: array
items:
type: string
format: date-time
minItems: 1
nullable: true
in: query
name: last_executed_at
required: false
description: Last executed at
- schema:
type: array
items:
type: string
format: date-time
minItems: 1
nullable: true
in: query
name: created_at
required: false
description: Created at
- schema:
type: array
items:
type: string
format: date-time
minItems: 1
nullable: true
in: query
name: updated_at
required: false
description: Updated at
- 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:
- '-next_execution_at, status'
example2:
value:
- '-created_at'
- status
example3:
value:
- updated_at
example4:
value:
- '-action_name'
in: query
name: sort
required: false
description: >-
Sort by fields. Prefix with `-` for descending order. Default is
ascending order.
responses:
'200':
description: Returns the scheduled flow_runs
content:
application/json:
schema:
description: Returns the scheduled flow_runs
type: array
items:
type: object
properties:
uid:
type: string
format: uuid
description: A unique identifier for the scheduled flow run.
flow_preset_uid:
type: string
format: uuid
description: >-
A unique identifier for the flow preset associated with
this scheduled execution.
flow_preset_name:
type: string
description: >-
The human-readable name of the flow preset executed by
this schedule.
user_uid:
type: string
format: uuid
description: >-
A unique identifier for the user associated with this
scheduled flow run.
workspace_uid:
type: string
format: uuid
description: >-
A unique identifier for the workspace associated with
this scheduled flow run.
status:
type: string
enum:
- ACTIVE
- CANCELLED
- PAUSED
- COMPLETED
nullable: true
description: The current status of the scheduled flow run.
postponed_until:
type: string
format: date-time
nullable: true
description: >-
If the flow run is postponed, this field indicates when
it will be retried.
cron:
type: string
description: >-
The cron expression (in POSIX format) defining the
schedule for the flow run.
nullable: true
timezone:
type: string
description: The IANA timezone for the scheduled flow run.
nullable: true
next_execution_at:
type: string
format: date-time
description: The date and time of the next scheduled execution.
nullable: true
last_executed_at:
type: string
format: date-time
description: The date and time when the flow run was last executed.
nullable: true
created_at:
type: string
format: date-time
description: >-
The date and time when the scheduled flow run was
created.
nullable: true
updated_at:
type: string
format: date-time
description: >-
The date and time when the scheduled flow run was last
updated.
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
````