List Schedules

List schedules

curl --request GET \
  --url https://inference.studio.lyzr.ai/api/workflow-schedules \
  --header 'x-api-key: <api-key>'

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

fetch('https://inference.studio.lyzr.ai/api/workflow-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://inference.studio.lyzr.ai/api/workflow-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://inference.studio.lyzr.ai/api/workflow-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://inference.studio.lyzr.ai/api/workflow-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

{
  "schedules": [
    {
      "id": "<string>",
      "workflow_id": "<string>",
      "cron_expression": "<string>",
      "timezone": "<string>",
      "is_active": true,
      "max_retries": 123,
      "retry_delay": 123,
      "run_count": 123,
      "last_run_at": "<string>",
      "next_run_time": "<string>",
      "user_id": "<string>",
      "org_id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ]
}

{
  "error": "<string>"
}

GET

workflow-schedules

List schedules

curl --request GET \
  --url https://inference.studio.lyzr.ai/api/workflow-schedules \
  --header 'x-api-key: <api-key>'

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

fetch('https://inference.studio.lyzr.ai/api/workflow-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://inference.studio.lyzr.ai/api/workflow-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://inference.studio.lyzr.ai/api/workflow-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://inference.studio.lyzr.ai/api/workflow-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

{
  "schedules": [
    {
      "id": "<string>",
      "workflow_id": "<string>",
      "cron_expression": "<string>",
      "timezone": "<string>",
      "is_active": true,
      "max_retries": 123,
      "retry_delay": 123,
      "run_count": 123,
      "last_run_at": "<string>",
      "next_run_time": "<string>",
      "user_id": "<string>",
      "org_id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ]
}

{
  "error": "<string>"
}

Authorizations

x-api-key

string

header

required

Lyzr API key. Studio session keys (agk_, ags_) and durable sk- keys are accepted. Required on every endpoint except GET /node-types and a webhook-triggered execute that carries X-Webhook-Secret.

Response

schedules

object[]

Show child attributes

Agents

Sessions

Orchestration

Scheduler

Webhooks

Tools

Voice Agents

Knowledge Base

Knowledge Graph

Responsible & Safe AI

List Schedules

Authorizations

Response