Skip to content
LeadPattern
Reference/Flows

Flows API

LeadPattern Flows API: 4 endpoints with request parameters, response schemas, error codes and cURL, Node.js and Python examples.

GETList Flows/flows?status=publishedRetrieve WhatsApp Flows created in the workspace, paginated. Filter by status (draft, published, deprecated) or Meta Flow category.GETGet Flow/flows/:idRetrieve a single Flow's full definition, including its screens and Meta flowId.POSTSend Flow/flows/:id/sendSend a published Flow to a contact by phone (waId) or bsuid. Only flows with status "published" can be sent.GETList Flow Submissions/flows/:id/submissions?page=1&limit=20Retrieve completed submissions for a Flow — the field values a contact submitted, correlated back to the send via flowToken.