Get the published Flow JSON

GET 
/v1/flows/:flow_id/schema

The WhatsApp Flow JSON document of the flow's current published version, exactly as stored, with no envelope. Pass version to read a specific version's document in any state — a draft still uploading, a failed one, a deprecated predecessor. Without version, a flow that has no published version answers 422 no_published_version, the same code POST /v1/flows/{flow_id}/submissions sends for the same condition. Requires the flows:read scope.

Request

Responses

200

The Flow JSON document.

400

A malformed flow_id or version (code: invalid_parameter), or an unrecognised query parameter (code: unknown_parameter).

401

Missing, malformed, unknown, revoked, or expired key — one body for all of them (code: unauthorized), with WWW-Authenticate: Bearer realm="hop".

403

The key lacks the scope (code: insufficient_scope), named in WWW-Authenticate: Bearer error="insufficient_scope", scope="…".

404

No such flow, or version is not a version of this flow. Both answer identically (code: not_found).

422

The flow has no published version and no version was given (code: no_published_version).

429

Over a bucket. Obey Retry-After (seconds); RateLimit-* fields are informational.

Response Headers

RateLimit-Limit

Requests allowed in the current window. Informational.

RateLimit-Remaining

Requests left in the current window. Informational.

RateLimit-Reset

Seconds until the window resets. Informational.

Retry-After

Seconds to wait before retrying. The binding contract.