Flows
List Flows
Lists the WhatsApp Flows of the WABA behind the key’s bound number, most recently updated first. The WABA is DERIVED from the key — there is no parameter that names one. id is the local cuid and is the only id you ever send back to us; metaFlowId is Meta’s, read-only, and null while a Flow exists here but has not reached Meta. Page-based pagination with a totalPages envelope. Permission flows:read.
Requires a number-scoped key. A tenant-scoped key must name the number with the x-whatsapp-number-id header, or it gets 403 TENANT_SCOPE_NOT_ALLOWED.
GET
/
v1
/
flows
List Flows
curl --request GET \
--url https://pilotstatus.com.br/v1/flows \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/flows"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://pilotstatus.com.br/v1/flows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://pilotstatus.com.br/v1/flows",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://pilotstatus.com.br/v1/flows"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://pilotstatus.com.br/v1/flows")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/flows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"flows": [
{
"id": "cmf1a2b3c4d5e6f7g8h9i0j1",
"metaFlowId": "1122334455",
"name": "Agendamento",
"metaStatus": "PUBLISHED",
"healthStatus": "AVAILABLE",
"categories": [
"APPOINTMENT_BOOKING"
],
"jsonVersion": "7.1",
"clonedFromFlowId": null,
"supersededByFlowId": null,
"createdAt": "2026-08-30T12:00:00.000Z",
"updatedAt": "2026-09-01T09:12:00.000Z"
}
],
"total": 1,
"page": 1,
"pageSize": 30,
"totalPages": 1
}{
"error": "Paginação profunda demais: page × pageSize não pode passar de 10000.",
"errorEN": "Pagination too deep: page × pageSize must not exceed 10000.",
"code": "INVALID_PAGINATION"
}{
"error": "Unauthorized"
}{
"error": "Tenant-scoped keys cannot call number endpoints",
"code": "TENANT_SCOPE_NOT_ALLOWED"
}{
"error": "Flows existem apenas em números Meta (API Oficial). O número desta chave não é Meta ou não tem uma WABA associada — use uma chave de um número Meta.",
"errorEN": "Flows only exist on Meta (Cloud API) numbers. This key's number is not a Meta number, or has no WABA behind it — use a key bound to a Meta number.",
"code": "FLOW_REQUIRES_META_NUMBER"
}{
"error": "Too many requests"
}{
"error": "Erro interno do servidor.",
"errorEN": "Internal server error.",
"code": "INTERNAL_ERROR"
}Was this page helpful?
⌘I
List Flows
curl --request GET \
--url https://pilotstatus.com.br/v1/flows \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/flows"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://pilotstatus.com.br/v1/flows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://pilotstatus.com.br/v1/flows",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://pilotstatus.com.br/v1/flows"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://pilotstatus.com.br/v1/flows")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/flows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"flows": [
{
"id": "cmf1a2b3c4d5e6f7g8h9i0j1",
"metaFlowId": "1122334455",
"name": "Agendamento",
"metaStatus": "PUBLISHED",
"healthStatus": "AVAILABLE",
"categories": [
"APPOINTMENT_BOOKING"
],
"jsonVersion": "7.1",
"clonedFromFlowId": null,
"supersededByFlowId": null,
"createdAt": "2026-08-30T12:00:00.000Z",
"updatedAt": "2026-09-01T09:12:00.000Z"
}
],
"total": 1,
"page": 1,
"pageSize": 30,
"totalPages": 1
}{
"error": "Paginação profunda demais: page × pageSize não pode passar de 10000.",
"errorEN": "Pagination too deep: page × pageSize must not exceed 10000.",
"code": "INVALID_PAGINATION"
}{
"error": "Unauthorized"
}{
"error": "Tenant-scoped keys cannot call number endpoints",
"code": "TENANT_SCOPE_NOT_ALLOWED"
}{
"error": "Flows existem apenas em números Meta (API Oficial). O número desta chave não é Meta ou não tem uma WABA associada — use uma chave de um número Meta.",
"errorEN": "Flows only exist on Meta (Cloud API) numbers. This key's number is not a Meta number, or has no WABA behind it — use a key bound to a Meta number.",
"code": "FLOW_REQUIRES_META_NUMBER"
}{
"error": "Too many requests"
}{
"error": "Erro interno do servidor.",
"errorEN": "Internal server error.",
"code": "INTERNAL_ERROR"
}