Skip to content

How to list WhatsApp forms via API v2

/v2/forms maps to Meta WhatsApp Flows. GET /v2/forms lists from Graph. GET /v2/forms/search queries AvenPing saved forms. GET /v2/forms/:flowId returns one Graph object. Do not clone the endpoint table; use Forms.

Prerequisites

Step-by-step

  1. Authenticate
    Send Bearer or X-API-Token. Call GET /v2/me if you need phoneNumberId or accountId for a specific WABA.

  2. List Meta flows
    GET /v2/forms. Optional phoneNumberId or accountId selects the linked WABA.

  3. Search AvenPing rows
    GET /v2/forms/search?q=...&limit=10 (limit 1–50). Call /search as a path so it is not treated as a flow id.

  4. Fetch one flow
    GET /v2/forms/:flowId with a Meta flow id. Empty id returns 400 VALIDATION_ERROR.

TIP

To send a form from a chat, use the inbox or chatbot Form block. This API lists and reads flows; it is not a substitute for Send Form.

FAQ

Why is search hitting :flowId?

You requested /v2/forms/search incorrectly. Use the search path, not a flow id named search.

Does list include DRAFT forms from the UI?

Graph list is Meta flows. search reads AvenPing DB rows. Publish in Broadcast → Forms if Graph should see the flow.

Can I submit form answers through this API?

Listing and fetch only. Customers submit inside WhatsApp. Export responses in the dashboard.