---
title: "Retrieve a flow"
method: GET
path: "/whatsapp/flows/{flowId}"
tags: ["WhatsApp Flows"]
---

# Retrieve a flow

`GET /whatsapp/flows/{flowId}`

Retrieves a WhatsApp Flow's details.

## Path parameters

- `flowId` string, required

## Response `200`

Successfully retrieved the flow.

- WhatsappFlow — Represents a WhatsApp Flow.
  - `id` string — Flow ID.
  - `name` string — Flow name.
  - `status` 'DRAFT' | 'PUBLISHED' | 'DEPRECATED' — Status of the WhatsApp Flow. - `DRAFT`: The Flow is in draft state and can be modified. - `PUBLISHED`: The Flow is published and cannot be modified. - `DEPRECATED`: The Flow is deprecated and cannot be used.
  - `categories` WhatsappFlowCategory[] — Flow categories.
  - `whatsappBusinessAccount` object — WhatsApp Business Account information.
    - `id` string — WhatsApp Business Account ID.
    - `name` string — WhatsApp Business Account name.
    - `currency` string — Currency used by the WhatsApp Business Account.
  - `validationErrors` WhatsappFlowValidationError[] — List of validation errors.
    - `error` string — Error code.
    - `errorType` string — Error type.
    - `message` string — Error message.
    - `lineStart` integer — Start line of the error.
    - `lineEnd` integer — End line of the error.
    - `columnStart` integer — Start column of the error.
    - `columnEnd` integer — End column of the error.
    - `pointers` object[] — List of pointers to the error location.
      - `lineStart` integer — Start line of the error.
      - `lineEnd` integer — End line of the error.
      - `columnStart` integer — Start column of the error.
      - `columnEnd` integer — End column of the error.
      - `path` string — Path to the error location.
  - `jsonVersion` string — Version of the Flow JSON structure.
  - `dataApiVersion` string — Version of the Data API.
  - `endpointUri` string — The endpoint URI for the Flow.

---

[API](https://skmtc.dev/ycloud/apis/ycloud-api.md) · [All operations](https://skmtc.dev/ycloud/apis/ycloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ycloud/ycloud-api/revisions/4e13d3ca9df8/schema)
