Skip to main content
Get workflow
import requests

url = 'https://api.simplex.sh/workflow/your_workflow_id'
headers = {
    'X-API-Key': 'your_api_key_here'
}

response = requests.get(url, headers=headers)
result = response.json()
if result['succeeded']:
    workflow = result['workflow']
    print(f"Workflow: {workflow['name']}")
    print(f"Actions: {len(workflow['actions'])} actions")
{
  "succeeded": true,
  "workflow": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "actions": [
      {}
    ],
    "variables": {},
    "url": "<string>",
    "metadata": "<string>"
  }
}
Retrieve a specific workflow by its ID. Returns the workflow including name, actions, variables, URL, and metadata.

Path Parameters

​
workflow_id
string<uuid>
required

The ID of the workflow to retrieve

Response

Workflow retrieved successfully

​
succeeded
boolean
required

Whether the request succeeded

​
workflow
object
required