---
title: "Get Workflow"
method: GET
path: "/api/v1/workflows/{id}"
tags: ["Workflows"]
---

# Get Workflow

`GET /api/v1/workflows/{id}`

Retrieve details for a single workflow, including its input fields and deployment status.

## Path parameters

- `id` string, required

## Response `200`

Workflow details including input field definitions.

- object
  - `data` WorkflowDetail — Full workflow representation including input field definitions and configuration.
    - `id` string — Unique workflow identifier.
    - `name` string — Human-readable workflow name.
    - `description` string, nullable — Optional description of what the workflow does.
    - `folderId` string, nullable — The folder this workflow belongs to. null if at the workspace root.
    - `workspaceId` string — The workspace this workflow belongs to.
    - `isDeployed` boolean — Whether the workflow is currently deployed and available for API execution.
    - `deployedAt` string, date-time, nullable — ISO 8601 timestamp of the most recent deployment. null if never deployed.
    - `runCount` integer — Total number of times this workflow has been executed.
    - `lastRunAt` string, date-time, nullable — ISO 8601 timestamp of the most recent execution. null if never run.
    - `variables` object — Workflow-level variables and their current values.
    - `inputs` object — The workflow's input field definitions. Use these to construct the input object when executing the workflow.
      - `fields` object — Map of field names to their type definitions and configuration.
    - `createdAt` string, date-time — ISO 8601 timestamp when the workflow was created.
    - `updatedAt` string, date-time — ISO 8601 timestamp when the workflow was last modified.
  - `limits` Limits — Rate limit and usage information included in every API response.
    - `workflowExecutionRateLimit` object — Current rate limit status for workflow executions.
      - `sync` RateLimitBucket — Rate limit status for a specific execution type.
        - `requestsPerMinute` integer — Maximum number of requests allowed per minute.
        - `maxBurst` integer — Maximum number of concurrent requests allowed in a burst.
        - `remaining` integer — Number of requests remaining in the current rate limit window.
        - `resetAt` string, date-time — ISO 8601 timestamp when the rate limit window resets.
      - `async` RateLimitBucket — Rate limit status for a specific execution type.
        - `requestsPerMinute` integer — Maximum number of requests allowed per minute.
        - `maxBurst` integer — Maximum number of concurrent requests allowed in a burst.
        - `remaining` integer — Number of requests remaining in the current rate limit window.
        - `resetAt` string, date-time — ISO 8601 timestamp when the rate limit window resets.
    - `usage` object — Current billing period usage and plan limits.
      - `currentPeriodCost` number — Total spend in the current billing period in USD.
      - `limit` number — Maximum allowed spend for the current billing period in USD.
      - `plan` string — Your current subscription plan (e.g., free, pro, team).
      - `isExceeded` boolean — Whether the usage limit has been exceeded. Executions may be blocked when true.

## Other responses

- `401` — Invalid or missing API key. Ensure the X-API-Key header is set with a valid key.
- `404` — The requested resource was not found. Verify the ID is correct and belongs to your workspace.
- `429` — Rate limit exceeded. Wait for the duration specified in the Retry-After header before retrying. The X-RateLimit-* headers accompany every response from an authenticated v1 request — success and error alike — and are omitted only when the request fails authentication, since no rate-limit bucket is consulted in that case.

---

[API](https://skmtc.dev/simstudioai/apis/sim-api.md) · [All operations](https://skmtc.dev/simstudioai/apis/sim-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/simstudioai/sim-api/revisions/66a471c5b1df/schema)