For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
User GuideDeveloper GuidesAPI Reference
User GuideDeveloper GuidesAPI Reference
    • Overview
  • Runtype API
      • GETList flows
      • POSTCreate flow
      • GETGet flow details
      • PUTUpdate flow
      • DELDelete flow
      • GETExport flow for runtime (limited preview)
      • POSTPublish flow
      • POSTRun flow on records of a type
      • GETList flow step results
Dashboard
LogoLogo
Runtype APIFlows

Get flow details

GET
/v1/flows/:id
GET
/v1/flows/:id
$curl https://api.runtype.com/v1/flows/id \
>     -H "Authorization: <apiKey>" \
>     -H "Content-Type: application/json"
1{
2  "createdAt": "2024-06-10T09:15:00Z",
3  "flowSteps": [
4    {
5      "id": "step-1234abcd",
6      "type": "http-request",
7      "config": {
8        "retryCount": 3,
9        "timeoutSeconds": 30,
10        "webhookUrl": "https://hooks.example.com/step1"
11      },
12      "enabled": true,
13      "name": "Data Ingestion",
14      "order": 1
15    }
16  ],
17  "id": "8f14e45f-ceea-4d3a-9f2a-1b2c3d4e5f67",
18  "name": "User Signup Automation",
19  "organizationId": "org-9876zyxw",
20  "updatedAt": "2024-06-11T16:00:00Z",
21  "userId": "user-4567qwer",
22  "dashboardUrl": "https://dashboard.runtype.com/flows/8f14e45f-ceea-4d3a-9f2a-1b2c3d4e5f67",
23  "lastRunAt": "2024-06-12T14:45:00Z",
24  "sampleMetadata": {
25    "source": "signup-form",
26    "version": "1.2.0"
27  },
28  "stepCount": 1
29}
Get a flow by ID including its step definitions.
Was this page helpful?
Previous

Update flow

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired

Response

Flow details with steps
createdAtstring
flowStepslist of objects
idstring
namestring
organizationIdstring or null
updatedAtstring
userIdstring
dashboardUrlstring
lastRunAtstring or null
sampleMetadatamap from strings to any
stepCountinteger

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error