ReferenceFlowsGet Flow

Get Flow

GEThttps://public.leadpattern.com/flows/:id

Plan: flowsapplication/json60 req/min

Retrieve a single Flow's full definition, including its screens and Meta flowId.

Headers

1 field

Authorizationstring

required

Your API key. Sent raw (e.g. 'lp_...'). No Bearer prefix required.

Path Parameters

1 field

idstring

required

Flow ID.

Responses

JSON Response

{
  "type": "success",
  "data": {
    "id": "664abc123def456789012345",
    "name": "Lead Capture",
    "description": "Capture name and email before booking a demo.",
    "category": "LEAD_GENERATION",
    "status": "published",
    "meta": {
      "flowId": "112233445566",
      "status": "PUBLISHED"
    },
    "screens": [
      {
        "screenId": "WELCOME",
        "title": "Welcome",
        "fields": [
          {
            "name": "email",
            "componentType": "TextInput",
            "label": "Email",
            "required": true
          }
        ]
      }
    ]
  }
}

Sample Request

{}