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
  • Runtype API
      • GETList flows
      • POSTCreate flow
      • GETGet flow details
      • PUTUpdate flow
      • DELDelete flow
      • GETList flow step results
      • POSTPublish flow
      • POSTRun flow on records of a type
      • GETExport flow for runtime
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: Bearer <token>" \
>     -H "Content-Type: application/json"
1{
2  "id": "a3f47c2e-9b1d-4f3a-8c2e-7d9b1f3a8c2e",
3  "name": "User Onboarding Flow",
4  "status": "active",
5  "createdAt": "2024-05-10T09:15:00Z",
6  "updatedAt": "2024-06-01T12:00:00Z",
7  "userId": "user_789fgh1234",
8  "organizationId": "org_456xyz7890",
9  "flowSteps": [
10    {
11      "id": "step_00123abc",
12      "type": "email",
13      "name": "Welcome Email",
14      "order": 1,
15      "enabled": true,
16      "config": {
17        "subject": "Welcome to Runtype!",
18        "templateId": "tmpl_987zyx654"
19      }
20    }
21  ],
22  "lastRunAt": "2024-06-05T08:30:00Z",
23  "stepCount": 1,
24  "sampleMetadata": {
25    "lastModifiedBy": "user_789fgh1234",
26    "environment": "production"
27  },
28  "dashboardUrl": "https://dashboard.runtype.com/flows/a3f47c2e-9b1d-4f3a-8c2e-7d9b1f3a8c2e",
29  "draftVersionId": "draft_20240601v2"
30}
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
idstring
namestring
statusstring
createdAtstring
updatedAtstring
userIdstring
organizationIdstring or null
flowStepslist of objects
lastRunAtstring or null
stepCountinteger
sampleMetadatamap from strings to any
dashboardUrlstring
draftVersionIdstring or null

Errors

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