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
      • GETGet all flow steps for a flow
Dashboard
LogoLogo
Runtype APIFlow Steps

Get all flow steps for a flow

GET
/v1/flow-steps/flow/:flowId
GET
/v1/flow-steps/flow/:flowId
$curl https://api.runtype.com/v1/flow-steps/flow/flowId \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json"
1{
2  "data": [
3    {
4      "id": "a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f9a1d6c",
5      "flowId": "flow_987654321",
6      "type": "email",
7      "order": 1,
8      "enabled": true,
9      "config": {
10        "templateId": "welcome_01",
11        "subject": "Welcome to Runtype!",
12        "sender": "no-reply@runtype.com"
13      },
14      "userId": "user_123456789",
15      "createdAt": "2024-05-20T10:15:30Z",
16      "updatedAt": "2024-05-22T08:45:00Z",
17      "name": "Send Welcome Email",
18      "when": "user.signup.completed"
19    }
20  ],
21  "flowId": "flow_987654321",
22  "flowName": "User Onboarding Flow"
23}
Returns all steps stored in the flow config JSONB column, sorted by order.
Was this page helpful?
Previous

List versions for a flow

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

flowIdstringRequired

Response

Flow steps list
datalist of objects
flowIdstring
flowNamestring

Errors

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