Skip to content
Reference/Flows/List Flows

List Flows

GEThttps://public.leadpattern.com/flows
Plan: flowsapplication/json60 req/min

Retrieve WhatsApp Flows created in the workspace, paginated. Filter by status (draft, published, deprecated) or Meta Flow category.

Headers

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

Query Parameters

4 fields
pagenumber
optionaldefault: 1
Page number.
limitnumber
optionaldefault: 10
Results per page.
statusenum
optional
Filter by flow status.
Allowed values:
publisheddraftdeprecated
categorystring
optional
Filter by flow category.

Responses

JSON Response
{
  "type": "success",
  "data": {
    "results": [
      {
        "id": "664abc123def456789012345",
        "name": "Lead Capture",
        "category": "LEAD_GENERATION",
        "status": "published",
        "meta": {
          "flowId": "112233445566"
        }
      }
    ],
    "totalResults": 1,
    "page": 1,
    "totalPages": 1
  }
}

Sample Request

{
  "page": 1,
  "limit": 10,
  "status": "published (optional)",
  "category": "LEAD_GENERATION (optional)"
}