---
title: "Get workflow"
method: GET
path: "/api/apps/{app_id}/workflows/{workflow_id}"
---

# Get workflow

`GET /api/apps/{app_id}/workflows/{workflow_id}`

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Reads one workflow, including the full definition it currently runs.

This is the only endpoint that returns `definition`. The list endpoint leaves it out.

This endpoint is limited to 60 requests per minute.

<Warning>The response includes fields beyond the ones documented here. Don't rely on undocumented response fields, as they can change at any time.</Warning>

<Note>This endpoint accepts a personal API key. Workspace API keys are not authorized for it and are rejected with a 403.</Note>

## Path parameters

- `app_id` string, required — ID of the app whose workflows you want to work with.
- `workflow_id` string, required — ID of the workflow, as returned in `id` by [List workflows](/api-reference/list-workflows).

## Response `200`

The workflow, including its current definition.

- WorkflowResponse
  - `id` string, required — ID of the workflow.
  - `app_id` string, required — ID of the app the workflow belongs to.
  - `file_key` string, nullable — Name of the workflow's file in the app's code. `null` on workflows saved before files were kept.
  - `name` string, required — Name of the workflow.
  - `description` string, nullable — What the workflow is for.
  - `status` string, required — Whether the workflow runs: `active`, `inactive`, or `archived`.
  - `status_reason` string, nullable — Why Base44 stopped the workflow itself, as a fixed code: `consecutive_failures`, `end_condition_reached`, `migration_activation_failed`, or `workflows_not_available`. `null` when you set the status yourself.
  - `current_version_id` string, nullable — Version the workflow runs today, as the SHA-256 hash of that definition. `null` until a definition is saved.
  - `trigger` object — What starts the workflow. The trigger sits under `config`, keyed by `trigger_type`.
  - `app_type_context` object, nullable — Which app surface the workflow was authored against.
  - `last_run_at` string, date-time, nullable — When the workflow last started running. `null` before its first run.
  - `last_run_status` string, nullable — How that run ended: `success`, `failed`, or `cancelled`. `null` before the first run. Note this is a different set of values from a run's own `status`, which reports `completed` rather than `success`.
  - `consecutive_failures` integer — Runs that have failed in a row. Resets on the next success.
  - `total_runs` integer — Runs the workflow has started, ever.
  - `successful_runs` integer — Runs that finished successfully, ever.
  - `failed_runs` integer — Runs that ended in an error, ever.
  - `created_date` string, date-time, nullable — When the workflow was created.
  - `updated_date` string, date-time, nullable — When the workflow was last changed.
  - `created_by` string, nullable — Email of whoever created the workflow.
  - `definition` object, nullable — The steps the workflow runs, as a CNCF Serverless Workflow v1.0 document. `null` when no version has been saved yet. Only this endpoint returns it; the list endpoint does not.

## Other responses

- `401` — Missing or invalid credentials.
- `403` — You don't have access to this app, the app does not exist, the app still runs the older automations engine instead of workflows, or you used a workspace API key. A missing app and an app you cannot reach are deliberately the same answer.
- `404` — There is no workflow with this ID on this app.
- `422` — Validation Error

---

[API](https://skmtc.dev/idealspot/apis/base44-app-management-api.md) · [All operations](https://skmtc.dev/idealspot/apis/base44-app-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/idealspot/base44-app-management-api/revisions/31ef75eb64ab/schema)