---
title: "Read a workflow"
description: "The workflow with one version in full (the latest unless `version` names another): its source, the compiler's verdict, the graph, the notes, and the list of every version."
canonical: "https://grid82.com/docs/app-api/my/workflows-get"
updated: "2026-11-13"
---

# Read a workflow

`GET https://your-suite.grid82.app/your-app/v1/workflows/{workflowId}`

The workflow with one version in full (the latest unless `version` names another): its source, the compiler's verdict, the graph, the notes, and the list of every version.

> **Note: Generic contract**
>
> Your own version of this operation, with your tables and the fields you can read, is in
> your app's document: `https://{suite}.grid82.app/{app}/v1/openapi.json`, behind your credential.
> [Why each person gets their own](/docs/start/studio-and-runtime#why-an-app-has-an-api-of-its-own).

Requires the `workflows:read` scope. Operation `my.workflows.get`. MCP tool `my_workflows_get`. CLI: `grid82 my workflows get` (`npx grid82`).

## Path parameters

| Name         | Type   | Required | Description |
| ------------ | ------ | -------- | ----------- |
| `workflowId` | string | yes      |             |

## Query parameters

| Name      | Type    | Required | Description |
| --------- | ------- | -------- | ----------- |
| `version` | integer | no       |             |

**Authorizations**

- `Authorization` (bearer, in header, required)

## Response

**200**: Success

- `data` (`object`, required)
- `data.id` (`string`, required)
- `data.name` (`string`, required)
- `data.mode` (`enum<string>`, required, one of: `locked, personal`)
- `data.owner` (`string`, required)
- `data.status` (`enum<string>`, required, one of: `draft, active, paused`)
- `data.latestVersion` (`integer`, required)
- `data.activeVersion` (`integer | null`, required)
- `data.trigger` (`Record<string, object> | null`, required)
- `data.updatedAt` (`string`, required)
- `data.lastRun` (`object | null`, required)
- `data.lastRun.id` (`string`, required)
- `data.lastRun.status` (`string`, required)
- `data.lastRun.startedAt` (`string`, required)
- `data.lastRun.error` (`string,null`, required)
- `data.version` (`object | null`, required)
- `data.version.version` (`integer`, required)
- `data.version.source` (`string`, required)
- `data.version.note` (`string,null`, required)
- `data.version.via` (`string,null`, required)
- `data.version.author` (`string`, required)
- `data.version.at` (`string`, required)
- `data.version.ok` (`boolean`, required)
- `data.version.errors` (`object[]`, required)
- `data.version.errors.line` (`integer`, required)
- `data.version.errors.message` (`string`, required)
- `data.version.warnings` (`object[]`, required)
- `data.version.warnings.line` (`integer`, required)
- `data.version.warnings.message` (`string`, required)
- `data.version.config` (`Record<string, object> | null`, required)
- `data.version.graph` (`Record<string, object> | null`, required)
- `data.version.manifest` (`object[]`, required)
- `data.version.impact` (`Record<string, object> | null`, required)
- `data.version.notes` (`Record<string, string>`, required)
- `data.version.bundleHash` (`string,null`, required)
- `data.versions` (`object[]`, required)
- `data.versions.version` (`integer`, required)
- `data.versions.note` (`string,null`, required)
- `data.versions.via` (`string,null`, required)
- `data.versions.author` (`string`, required)
- `data.versions.at` (`string`, required)
- `data.versions.ok` (`boolean`, required)
- `data.versions.bundleHash` (`string,null`, required)
- `data.versions.active` (`boolean`, required)

```json
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "mode": "locked",
    "owner": "<string>",
    "status": "draft",
    "latestVersion": 123,
    "activeVersion": 123,
    "trigger": {},
    "updatedAt": "<string>",
    "lastRun": {
      "id": "<string>",
      "status": "<string>",
      "startedAt": "<string>",
      "error": null
    },
    "version": {
      "version": 123,
      "source": "<string>",
      "note": null,
      "via": null,
      "author": "<string>",
      "at": "<string>",
      "ok": true,
      "errors": [
        {
          "line": 123,
          "message": "<string>"
        }
      ],
      "warnings": [
        {
          "line": 123,
          "message": "<string>"
        }
      ],
      "config": {},
      "graph": {},
      "manifest": [
        null
      ],
      "impact": {},
      "notes": {},
      "bundleHash": null
    },
    "versions": [
      {
        "version": 123,
        "note": null,
        "via": null,
        "author": "<string>",
        "at": "<string>",
        "ok": true,
        "bundleHash": null,
        "active": true
      }
    ]
  }
}
```

**4XX**: Refused

- `error` (`object`, required)
- `error.code` (`enum<string>`, required, one of: `not_found, forbidden, unauthenticated, validation_failed, conflict, rate_limited, payment_required, not_implemented, internal`)
- `error.message` (`string`, required)
- `error.details` (`Record<string, unknown>`)

```json
{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "details": {}
  }
}
```

**Example request**

```bash
curl --request GET \
  --url 'https://your-suite.grid82.app/your-app/v1/workflows/<workflowId>' \
  --header 'Authorization: Bearer <token>'
```