Get flow details | Runtype Documentation

{
  "createdAt": "2024-06-10T09:15:00Z",
  "flowSteps": [
    {
      "id": "step-1a2b3c4d",
      "type": "email",
      "config": {
        "emailTemplateId": "welcome_2024",
        "retryCount": 3
      },
      "enabled": true,
      "name": "Send Welcome Email",
      "order": 1
    }
  ],
  "id": "8a7f3c2d-4b9e-4f1a-9c3e-2d5f7b6a1e9c",
  "name": "User Onboarding Flow",
  "organizationId": "org-1234567890abcdef",
  "updatedAt": "2024-06-12T11:30:00Z",
  "userId": "user-1234abcd5678efgh",
  "dashboardUrl": "https://dashboard.runtype.com/flows/8a7f3c2d-4b9e-4f1a-9c3e-2d5f7b6a1e9c",
  "description": "Automated onboarding flow for new users",
  "lastRunAt": "2024-06-15T14:45:00Z",
  "sampleMetadata": {
    "sampleUserId": "user-9876543210fedcba",
    "environment": "production"
  },
  "stepCount": 1
}

Get a flow by ID including its step definitions.

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

descriptionstring or null

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

$	curl https://api.runtype.com/v1/flows/id \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json"