Read a workflow

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.

GET/v1/workflows/{workflowId}

Request

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

import json
import requests

url = "https://your-suite.grid82.app/your-app/v1/workflows/<workflowId>"
headers = {
  "Authorization": "Bearer <token>"
}

response = requests.request("GET", url, headers=headers)
print(response.json())

const response = await fetch("https://your-suite.grid82.app/your-app/v1/workflows/<workflowId>", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  },
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://your-suite.grid82.app/your-app/v1/workflows/<workflowId>");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <token>",
]);
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://your-suite.grid82.app/your-app/v1/workflows/<workflowId>", nil)
  req.Header.Set("Authorization", "Bearer <token>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://your-suite.grid82.app/your-app/v1/workflows/<workflowId>"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://your-suite.grid82.app/your-app/v1/workflows/<workflowId>")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/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
      }
    ]
  }
}

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

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

Response

application/json

Success

dataobjectrequired

Show child attributes

data.idstringrequired

data.namestringrequired

data.modeenum<string>requiredone of: locked, personal

data.ownerstringrequired

data.statusenum<string>requiredone of: draft, active, paused

data.latestVersionintegerrequired

data.activeVersioninteger | nullrequired

data.triggerRecord<string, object> | nullrequired

data.updatedAtstringrequired

data.lastRunobject | nullrequired

Show child attributes

data.lastRun.idstringrequired

data.lastRun.statusstringrequired

data.lastRun.startedAtstringrequired

data.lastRun.errorstringnullrequired

data.versionobject | nullrequired

Show child attributes

data.version.versionintegerrequired

data.version.sourcestringrequired

data.version.notestringnullrequired

data.version.viastringnullrequired

data.version.authorstringrequired

data.version.atstringrequired

data.version.okbooleanrequired

data.version.errorsobject[]required

Show child attributes

data.version.errors.lineintegerrequired

data.version.errors.messagestringrequired

data.version.warningsobject[]required

Show child attributes

data.version.warnings.lineintegerrequired

data.version.warnings.messagestringrequired

data.version.configRecord<string, object> | nullrequired

data.version.graphRecord<string, object> | nullrequired

data.version.manifestobject[]required

data.version.impactRecord<string, object> | nullrequired

data.version.notesRecord<string, string>required

data.version.bundleHashstringnullrequired

data.versionsobject[]required

Show child attributes

data.versions.versionintegerrequired

data.versions.notestringnullrequired

data.versions.viastringnullrequired

data.versions.authorstringrequired

data.versions.atstringrequired

data.versions.okbooleanrequired

data.versions.bundleHashstringnullrequired

data.versions.activebooleanrequired

{ "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 } ] } }

Read a workflow

Path parameters

Query parameters

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown