Get an agent schedule by id

curl --request GET \
  --url https://api.skyvern.com/v1/agents/{workflow_permanent_id}/schedules/{workflow_schedule_id}

const options = {method: 'GET'};

fetch('https://api.skyvern.com/v1/agents/{workflow_permanent_id}/schedules/{workflow_schedule_id}', 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.skyvern.com/v1/agents/{workflow_permanent_id}/schedules/{workflow_schedule_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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.skyvern.com/v1/agents/{workflow_permanent_id}/schedules/{workflow_schedule_id}"

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

	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.skyvern.com/v1/agents/{workflow_permanent_id}/schedules/{workflow_schedule_id}")

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

request = Net::HTTP::Get.new(url)

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

{
  "schedule": {
    "workflow_schedule_id": "<string>",
    "organization_id": "<string>",
    "workflow_permanent_id": "<string>",
    "timezone": "<string>",
    "enabled": true,
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "cron_expression": "<string>",
    "interval_seconds": 123,
    "first_fire_at": "2023-11-07T05:31:56Z",
    "run_at": "2023-11-07T05:31:56Z",
    "dispatch_status": "pending",
    "workflow_run_id": "<string>",
    "parameters": {},
    "temporal_schedule_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "deleted_at": "2023-11-07T05:31:56Z"
  },
  "next_runs": [
    "2023-11-07T05:31:56Z"
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

GET

agents

{workflow_permanent_id}

schedules

{workflow_schedule_id}

Get an agent schedule by id

curl --request GET \
  --url https://api.skyvern.com/v1/agents/{workflow_permanent_id}/schedules/{workflow_schedule_id}

const options = {method: 'GET'};

fetch('https://api.skyvern.com/v1/agents/{workflow_permanent_id}/schedules/{workflow_schedule_id}', 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.skyvern.com/v1/agents/{workflow_permanent_id}/schedules/{workflow_schedule_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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.skyvern.com/v1/agents/{workflow_permanent_id}/schedules/{workflow_schedule_id}"

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

	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.skyvern.com/v1/agents/{workflow_permanent_id}/schedules/{workflow_schedule_id}")

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

request = Net::HTTP::Get.new(url)

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

{
  "schedule": {
    "workflow_schedule_id": "<string>",
    "organization_id": "<string>",
    "workflow_permanent_id": "<string>",
    "timezone": "<string>",
    "enabled": true,
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "cron_expression": "<string>",
    "interval_seconds": 123,
    "first_fire_at": "2023-11-07T05:31:56Z",
    "run_at": "2023-11-07T05:31:56Z",
    "dispatch_status": "pending",
    "workflow_run_id": "<string>",
    "parameters": {},
    "temporal_schedule_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "deleted_at": "2023-11-07T05:31:56Z"
  },
  "next_runs": [
    "2023-11-07T05:31:56Z"
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Headers

x-api-key

string | null

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Path Parameters

workflow_permanent_id

string

required

workflow_schedule_id

string

required

Response

Successful Response

schedule

WorkflowSchedule · object

required

Show child attributes

next_runs

string<date-time>[]

Agents

Runs

Folders

Server

Artifacts

Files

Browser Profiles

Browser Sessions

Credentials

Schedules

Recipes

Get an agent schedule by id

Headers

Path Parameters

Response