Flows

List Flow responses

The forms customers submitted to ONE Flow, newest first. The Flow is resolved inside the key’s own WABA first, and that resolution is the only thing that scopes what follows — a Flow of another WABA (including another WABA of the same tenant) answers 404 and no response is ever read.

Responses past their retention window are excluded HERE, not only by the pruning job, so a caller can never read a submission the published window says is gone. contactPhone is null when the phone is no longer ours to publish. externalMessageId is Meta’s wamid and is named as a provider id on purpose — every other id on this surface is local.

notice: "FLOW_RESPONSES_WINDOW_TRUNCATED" appears on the page when the Flow minted more sends than one request will correlate (a 10,000-session ceiling). A short answer that does not say it is short is what makes a caller conclude submissions were lost. 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

flows

{id}

responses

List Flow responses

curl --request GET \
  --url https://pilotstatus.com.br/v1/flows/{id}/responses \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://pilotstatus.com.br/v1/flows/{id}/responses', 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/{id}/responses",
  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/{id}/responses"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/flows/{id}/responses")

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

{
  "responses": [
    {
      "id": "cmf9z8y7x6w5v4u3t2s1r0q9",
      "flowId": "cmf1a2b3c4d5e6f7g8h9i0j1",
      "contactPhone": "5564999978874",
      "flowToken": "b7c1e4f2a9d84c6e8f0a1b2c3d4e5f60",
      "externalMessageId": "wamid.HBgNNTU2NDk5OTc4ODc0FQIAERgSN0E5...",
      "response": {
        "screen_0_nome": "Amanda",
        "screen_0_nota": "9"
      },
      "receivedAt": "2026-09-01T18:22:11.000Z",
      "expiresAt": "2026-10-01T18:22:11.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": "Flow não encontrado para o número desta chave.",
  "errorEN": "Flow not found for this key's number.",
  "code": "FLOW_NOT_FOUND"
}

{
  "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"
}

Authorizations

x-api-key

string

header

required

Your ps_ API key

Path Parameters

string

required

The local id of the Flow — the id field GET /v1/flows returns, never metaFlowId.

Query Parameters

page

integer

default:1

Page number, 1-based.

Required range: x >= 1

pageSize

integer

default:30

Rows per page. Default 30, maximum 100.

Required range: 1 <= x <= 100

Response

List Flow responses

curl --request GET \
  --url https://pilotstatus.com.br/v1/flows/{id}/responses \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://pilotstatus.com.br/v1/flows/{id}/responses', 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/{id}/responses",
  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/{id}/responses"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/flows/{id}/responses")

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

{
  "responses": [
    {
      "id": "cmf9z8y7x6w5v4u3t2s1r0q9",
      "flowId": "cmf1a2b3c4d5e6f7g8h9i0j1",
      "contactPhone": "5564999978874",
      "flowToken": "b7c1e4f2a9d84c6e8f0a1b2c3d4e5f60",
      "externalMessageId": "wamid.HBgNNTU2NDk5OTc4ODc0FQIAERgSN0E5...",
      "response": {
        "screen_0_nome": "Amanda",
        "screen_0_nota": "9"
      },
      "receivedAt": "2026-09-01T18:22:11.000Z",
      "expiresAt": "2026-10-01T18:22:11.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": "Flow não encontrado para o número desta chave.",
  "errorEN": "Flow not found for this key's number.",
  "code": "FLOW_NOT_FOUND"
}

{
  "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"
}

Endpoints

Workspace

List Flow responses

Authorizations

Path Parameters

Query Parameters

Response