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

Gets a workflow.

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

## Request

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

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/workflows/{workflow}`. |
| `uid` | `string` | `wf_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `WorkflowSpec` | Desired state. Required. |
| `status` | `WorkflowStatus` | 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. |

### WorkflowSpec

| Field | Type | What it is |
| --- | --- | --- |
| `handler_uri` | `string` | An HTTPS URI on port 443 whose host is a verified Network Domain of this project or a Hosting route the project owns. One of the `handler` group. |
| `service_handler` | `ServiceHandler` | A Hosting Service in the same environment, which may be scaled to zero. One of the `handler` group. |
| `retry_policy` | `RetryPolicy` | How a failed invocation is retried. |
| `timeouts` | `WorkflowTimeouts` | Invocation and Run deadlines. |
| `max_concurrent_runs` | `int32` | At most this many running Runs of this Workflow; 0 is unlimited within the plan. |

### WorkflowStatus

| Field | Type | What it is |
| --- | --- | --- |
| `observed_generation` | `int64` | The generation this status was computed from. Output only. |
| `conditions` | `Condition[]` | Ready, Reconciling, Stalled. Output only. |
| `resolved_handler_uri` | `string` | The handler URI the current generation resolved to. Output only. |

### ServiceHandler

| Field | Type | What it is |
| --- | --- | --- |
| `service` | `string` | The Hosting Service in the same environment. Required. |
| `path` | `string` | The request path, for example `/api/sylphx/workflows`. Required. |

### RetryPolicy

| Field | Type | What it is |
| --- | --- | --- |
| `max_attempts` | `int32` | Attempts per step, 1 to 100; default 10. |
| `initial_interval` | `duration` | The first backoff; default 1s. |
| `backoff_coefficient` | `double` | Backoff growth, 1.0 to 10.0; default 2.0. |
| `max_interval` | `duration` | The largest backoff; default 10m. |

### WorkflowTimeouts

| Field | Type | What it is |
| --- | --- | --- |
| `invocation_timeout` | `duration` | One handler invocation, 1s to 900s; default 60s. |
| `run_timeout` | `duration` | The whole Run, at most 365d; default 30d. |

### 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. |

## 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/workflows/workflow" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"
```

**TypeScript**

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

**Rust**

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

**CLI**

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

**Terraform**

```hcl
data "sylphx_workflows_workflow" "workflow" {
  name = "orgs/acme/projects/shop/envs/production/workflows/workflow"
}
```

**MCP**

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