---
title: "Inspect a WhatsApp form"
method: POST
path: "/api/v1/tools/get_whatsapp_form"
---

# Inspect a WhatsApp form

`POST /api/v1/tools/get_whatsapp_form`

## Request

- Base URL: `https://whatsync.app`
- URL: `https://whatsync.app/api/v1/tools/get_whatsapp_form`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Read one WhatsApp form: status, validation errors, a preview_url anyone can open in a browser to try the form (no login, valid about 30 days), Meta's sending blockers such as business verification, and its Flow JSON definition so you can edit a draft.

## Headers

- `Idempotency-Key` string

## Request body

- object
  - `form_id` string, required
  - `includeDefinition` boolean: Return the Flow JSON definition; defaults to true

## Response `200`

JSON result. Every response includes X-Request-Id.

- object

## Other responses

- `400`: API error
- `401`: API error
- `403`: API error
- `404`: API error
- `409`: API error
- `413`: API error
- `415`: API error
- `422`: API error
- `429`: API error
- `503`: API error

---

[API](https://skmtc.dev/whatsync/apis/whatsync-api.md) · [All operations](https://skmtc.dev/whatsync/apis/whatsync-api/llms.txt) · [OpenAPI document](https://skmtc.dev/whatsync/apis/whatsync-api/revisions/6fa5498b63b7?raw)