List Scheduled Flows

Get the scheduled flow_runs

curl --request GET \
  --url https://api.edges.run/v1/flows/schedules \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.edges.run/v1/flows/schedules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.edges.run/v1/flows/schedules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.edges.run/v1/flows/schedules"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.edges.run/v1/flows/schedules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "flow_preset_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "flow_preset_name": "<string>",
    "user_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "postponed_until": "2023-11-07T05:31:56Z",
    "cron": "<string>",
    "timezone": "<string>",
    "next_execution_at": "2023-11-07T05:31:56Z",
    "last_executed_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

{
  "error_label": "<string>",
  "error_ref": "ERR-12345",
  "message": "<string>",
  "status_code": 123,
  "params": {},
  "data": {}
}

{
  "error_label": "<string>",
  "error_ref": "ERR-12345",
  "message": "<string>",
  "status_code": 123,
  "params": {},
  "data": {}
}

GET

flows

schedules

Get the scheduled flow_runs

curl --request GET \
  --url https://api.edges.run/v1/flows/schedules \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.edges.run/v1/flows/schedules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.edges.run/v1/flows/schedules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.edges.run/v1/flows/schedules"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.edges.run/v1/flows/schedules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "flow_preset_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "flow_preset_name": "<string>",
    "user_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "postponed_until": "2023-11-07T05:31:56Z",
    "cron": "<string>",
    "timezone": "<string>",
    "next_execution_at": "2023-11-07T05:31:56Z",
    "last_executed_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

{
  "error_label": "<string>",
  "error_ref": "ERR-12345",
  "message": "<string>",
  "status_code": 123,
  "params": {},
  "data": {}
}

{
  "error_label": "<string>",
  "error_ref": "ERR-12345",
  "message": "<string>",
  "status_code": 123,
  "params": {},
  "data": {}
}

Retrieve a list of all scheduled flow runs in your workspace. You can filter by status, user, flow preset, and more.

Examples

List all active schedules

curl --request GET \
  --url 'https://api.edges.run/v1/flows/schedules?status=ACTIVE' \
  --header 'X-API-Key: <your-api-key>'

List schedules for a specific flow

curl --request GET \
  --url 'https://api.edges.run/v1/flows/schedules?flow_preset_slug=linkedin-people-enrich&status=ACTIVE' \
  --header 'X-API-Key: <your-api-key>'

List with pagination and sorting

curl --request GET \
  --url 'https://api.edges.run/v1/flows/schedules?limit=50&offset=0&sort=-next_execution_at' \
  --header 'X-API-Key: <your-api-key>'

This returns 50 schedules sorted by next execution time (soonest first).

List recently created schedules

curl --request GET \
  --url 'https://api.edges.run/v1/flows/schedules?limit=20&sort=-created_at' \
  --header 'X-API-Key: <your-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 or to manage it with Manage Schedule.

Authorizations

X-API-Key

string

header

required

Query Parameters

uid

string<uuid>[] | null

Scheduled flow_run UUID

Minimum array length: 1

status

enum<string>[] | null

Scheduled flow_run status

Minimum array length: 1

Available options:

ACTIVE,

CANCELLED,

PAUSED,

COMPLETED

user_uid

string<uuid>[] | null

User UUID

Minimum array length: 1

workspace_uid

string<uuid>[] | null

Workspace UUID

Minimum array length: 1

flow_preset_slug

string[] | null

Flow preset slug

Minimum array length: 1

next_execution_at

string<date-time>[] | null

Next execution at

Minimum array length: 1

last_executed_at

string<date-time>[] | null

Last executed at

Minimum array length: 1

created_at

string<date-time>[] | null

Created at

Minimum array length: 1

updated_at

string<date-time>[] | null

Updated at

Minimum array length: 1

limit

integer

default:10

Required range: 1 <= x <= 100

offset

integer

default:0

Required range: x >= 0

sort

string[]

Sort by fields. Prefix with - for descending order. Default is ascending order.

Maximum array length: 10

Maximum string length: 128

Response

Returns the scheduled flow_runs

uid

string<uuid>

A unique identifier for the scheduled flow run.

flow_preset_uid

string<uuid>

A unique identifier for the flow preset associated with this scheduled execution.

flow_preset_name

string

The human-readable name of the flow preset executed by this schedule.

user_uid

string<uuid>

A unique identifier for the user associated with this scheduled flow run.

workspace_uid

string<uuid>

A unique identifier for the workspace associated with this scheduled flow run.

status

enum<string> | null

The current status of the scheduled flow run.

Available options:

ACTIVE,

CANCELLED,

PAUSED,

COMPLETED

postponed_until

string<date-time> | null

If the flow run is postponed, this field indicates when it will be retried.

cron

string | null

The cron expression (in POSIX format) defining the schedule for the flow run.

timezone

string | null

The IANA timezone for the scheduled flow run.

next_execution_at

string<date-time> | null

The date and time of the next scheduled execution.

last_executed_at

string<date-time> | null

The date and time when the flow run was last executed.

created_at

string<date-time> | null

The date and time when the scheduled flow run was created.

updated_at

string<date-time> | null

The date and time when the scheduled flow run was last updated.

Schedule a Flow Get Schedule Details

API documentation

Runs & Schedules

Flows Presets

Single Actions

Examples

Schedule Statuses

Authorizations

Query Parameters

Response

​Examples

​Schedule Statuses

Authorizations

Query Parameters

Response

Examples

Schedule Statuses