Get Workflow

Get a single workflow with its full steps

Published Jul 11, 2026·Updated Jul 15, 2026

GET

/v1/workflows/{id}

curl -X GET "https://api.orshot.com/v1/workflows/<ID>" \
  -H "Authorization: Bearer <ORSHOT_API_KEY>"

$ch = curl_init("https://api.orshot.com/v1/workflows/<ID>");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <ORSHOT_API_KEY>",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);

require "net/http"
require "json"

uri = URI("https://api.orshot.com/v1/workflows/<ID>")
req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer <ORSHOT_API_KEY>"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Enterprise Only

The Workflows API is available only to first party clients like the Orshot MCP server and workspaces on the Enterprise plan. Checkout the Enterprise Pricing to get access.

Overview#

Returns one workflow, including its full steps, schedule and run stats.

Endpoint

https://api.orshot.com/v1/workflows/:id

Path Parameters#

Parameter	Type	Required	Description
`id`	Integer	Yes	The unique ID of the workflow

Request#

JavaScript

await fetch("https://api.orshot.com/v1/workflows/44", {
  method: "GET",
  headers: {
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
});

JSON

{
  "workflow": {
    "id": 44,
    "name": "Renders from new Drive files",
    "description": "Render a card for every new file in the folder",
    "status": "active",
    "trigger_type": "google_drive_new_file",
    "steps": [
      {
        "key": "google_drive_new_file",
        "type": "trigger",
        "config": { "folderId": "<DRIVE_FOLDER_ID>", "pollInterval": 10 }
      },
      {
        "key": "render",
        "type": "action",
        "config": {
          "templateId": "1443",
          "format": "jpg",
          "mapping": { "headline": "name", "hero_image": "image_url" }
        }
      },
      { "key": "orshot_url", "type": "destination", "config": {} }
    ],
    "schedule_config": { "poll": true, "frequency": "custom", "intervalMinutes": 10 },
    "next_run_at": "2026-07-11T09:00:00.000Z",
    "run_count": 128,
    "success_count": 126,
    "last_run_at": "2026-07-11T08:00:03.412Z",
    "last_status": "success",
    "required_connections": ["google_drive"],
    "is_shared": false,
    "share_slug": null,
    "created_at": "2026-06-20T11:24:09.551Z",
    "updated_at": "2026-07-11T08:00:04.101Z"
  }
}

Error Responses#

Workflow Not Found (404)#

JSON

{
  "error": "Not found"
}

Rate Limits#

60 requests per minute per workspace

Was this page helpful?

Ready to automate?

Start rendering images, PDFs and videos from your templates in under 2 minutes. Free plan, no credit card.

Get your API key

Image, PDF and video generation via API
Visual editor with AI and smart layouts
Zapier, Make, MCP and 50+ integrations
White-label embed for your own app
30 free credits — no credit card required