Skyvern: List all schedules for the organization

← Schedules operations · Get started

Operation skyvern.schedules_list_all

Provider route: GET /v1/schedules. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/skyvern with npm, or alter-sdk-skyvern with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { SkyvernIntegration } from "@alter-ai/skyvern";

async function execute(input: Parameters<SkyvernIntegration["schedules"]["listSchedules"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new SkyvernIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.schedules.listSchedules(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_skyvern import SkyvernIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = SkyvernIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.schedules.list_schedules(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.page	integer	Optional	Default: 1 Minimum: 1
query.page_size	integer	Optional	Default: 10 Maximum: 100 Minimum: 1
query.status	JSON	Optional	Filter by status: ‘active’ or ‘paused’
query.status (anyOf 1)	string	Alternative	One of: active, paused
query.status (anyOf 2)	null	Alternative
query.search	JSON	Optional	Search by workflow title or schedule name
query.search (anyOf 1)	string	Alternative
query.search (anyOf 2)	null	Alternative

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand List all schedules for the organization — response body

Referenced models: List all schedules for the organization — response body

Schemas

List all schedules for the organization — response body

Field	Type	Presence	Description and constraints
$	object	Root
page	JSON	Required within parent
page (anyOf 1)	integer	Alternative
page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
page_size	JSON	Required within parent
page_size (anyOf 1)	integer	Alternative
page_size (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
schedules	array	Required within parent
schedules[]	Model	Each item	Expand List all schedules for the organization — response body — schedules item
total_count	JSON	Required within parent
total_count (anyOf 1)	integer	Alternative
total_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List all schedules for the organization — response body — schedules item

List all schedules for the organization — response body — schedules item

Field	Type	Presence	Description and constraints
$	object	Root	Compact schedule projection for the org-wide list endpoint. Intentionally omits `backend_schedule_id` — the list view is for browsing schedules in the dashboard, not for managing the underlying execution-backend binding. Callers that need the backend id should fetch the individual schedule via the per-workflow get endpoint.
created_at	string	Required within parent	Format: date-time
cron_expression	JSON	Optional
cron_expression (anyOf 1)	string	Alternative
cron_expression (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
dispatch_status	JSON	Optional
dispatch_status (anyOf 1)	string	Alternative	Known values: pending, fired, canceled, failed
dispatch_status (anyOf 2)	null	Alternative
enabled	boolean	Required within parent
first_fire_at	JSON	Optional
first_fire_at (anyOf 1)	string	Alternative	Format: date-time
first_fire_at (anyOf 2)	null	Alternative
interval_seconds	JSON	Optional
interval_seconds (anyOf 1)	JSON	Alternative
interval_seconds (anyOf 1) (anyOf 1)	integer	Alternative
interval_seconds (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
interval_seconds (anyOf 2)	null	Alternative
modified_at	string	Required within parent	Format: date-time
name	JSON	Optional
name (anyOf 1)	string	Alternative
name (anyOf 2)	null	Alternative
next_run	JSON	Optional
next_run (anyOf 1)	string	Alternative	Format: date-time
next_run (anyOf 2)	null	Alternative
organization_id	string	Required within parent
parameters	JSON	Optional
parameters (anyOf 1)	object	Alternative	Additional keys: allowed
parameters (anyOf 2)	null	Alternative
run_at	JSON	Optional
run_at (anyOf 1)	string	Alternative	Format: date-time
run_at (anyOf 2)	null	Alternative
timezone	string	Required within parent
workflow_permanent_id	string	Required within parent
workflow_run_id	JSON	Optional
workflow_run_id (anyOf 1)	string	Alternative
workflow_run_id (anyOf 2)	null	Alternative
workflow_schedule_id	string	Required within parent
workflow_title	string	Required within parent

Policy, approvals and errors

SDK function policy ID: skyvern.schedules_list_all. Catalog operation: schedules_list_all. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source