---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Get a schedule"
description: "`workflows.schedules.get` (GET /v1/{name}): Gets a schedule."
type: reference
product: jobs
summary: "Gets a schedule."
updated: 2026-09-28
nav: false
---

Gets a schedule.

- **Path** `GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/schedules/schedule`
- **Scope** `workflows:read`
- **Effect** `read` — nothing is written.
- **Collection** [schedules](/docs/api/schedules)

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The name of the schedule to get. Required. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/schedules/{schedule}`. |
| `uid` | `string` | `sch_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `ScheduleSpec` | Desired state. Required. |
| `status` | `ScheduleStatus` | Observed state. Output only. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only. |
| `create_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

### ScheduleSpec

| Field | Type | What it is |
| --- | --- | --- |
| `workflow` | `string` | The Workflow the Schedule starts, in the same environment. Required. |
| `input` | `struct` | The input of every Run, at most 64 KiB of JSON. |
| `calendar` | `CalendarSpec` | A calendar: cron expression and time zone. One of the `trigger` group. |
| `interval` | `IntervalSpec` | A fixed interval. One of the `trigger` group. |
| `jitter` | `duration` | Random delay added to each fire, at most min(interval, 1h). |
| `overlap_policy` | `OverlapPolicy` | What a fire does while a previous Run is still running. One of `skip`, `buffer_one`, `buffer_all`, `cancel_other`, `allow`. |
| `catchup_window` | `duration` | Missed fires older than this are skipped; 10s to 365d. |
| `paused` | `bool` | Whether fires are paused. |
| `pause_note` | `string` | Why the Schedule is paused; shown in status. |

### ScheduleStatus

| Field | Type | What it is |
| --- | --- | --- |
| `observed_generation` | `int64` | The generation this status was computed from. Output only. |
| `conditions` | `Condition[]` | Ready, Reconciling, Stalled. Output only. |
| `next_fire_times` | `timestamp[]` | The next intended fire times. Output only. |
| `last_fire` | `ScheduleFire` | The most recent fire. Output only. |

### CalendarSpec

| Field | Type | What it is |
| --- | --- | --- |
| `cron` | `string` | A 5-field cron expression, for example `0 3 * * *`. Required. |
| `time_zone` | `string` | IANA time zone; default `UTC`. |

### IntervalSpec

| Field | Type | What it is |
| --- | --- | --- |
| `every` | `duration` | The period, 1s to 365d. Required. |
| `offset` | `duration` | Phase offset within each period. |

### Condition

| Field | Type | What it is |
| --- | --- | --- |
| `type` | `string` | The condition type, for example `Ready`. |
| `status` | `ConditionStatus` | Whether the condition holds. One of `true`, `false`, `unknown`. |
| `observed_generation` | `int64` | The generation this observation was made against. |
| `reason` | `string` | A machine-readable UpperCamelCase reason. |
| `message` | `string` | A customer-safe human-readable message. |
| `severity` | `Severity` | How severe a FALSE condition is. One of `info`, `warning`, `error`. |
| `transition_time` | `timestamp` | When `status` last changed. |

### ScheduleFire

| Field | Type | What it is |
| --- | --- | --- |
| `intended_time` | `timestamp` | The instant the fire was due. Output only. |
| `run` | `string` | The Run it started, if any. Output only. |
| `outcome` | `FireOutcome` | What the fire did. Output only. One of `started`, `skipped`, `buffered`. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/schedules/schedule" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"
```

**TypeScript**

```ts
const response = await sylphx.workflows.schedules.get({ name: 'orgs/acme/projects/shop/envs/production/schedules/schedule' })
```

**Rust**

```rust
let mut req = sylphx::workflows::GetScheduleRequest::default();
req.name = "orgs/acme/projects/shop/envs/production/schedules/schedule".to_string();
let response = sx.workflows().schedules().get(req).await?;
```

**CLI**

```bash
sylphx workflows schedules get orgs/acme/projects/shop/envs/production/schedules/schedule
```

**Terraform**

```hcl
data "sylphx_workflows_schedule" "schedule" {
  name = "orgs/acme/projects/shop/envs/production/schedules/schedule"
}
```

**MCP**

```json
{ "method_id": "workflows.schedules.get", "args": {"name":"orgs/acme/projects/shop/envs/production/schedules/schedule"} }
```