> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pilotstatus.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# 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`.



## OpenAPI

````yaml openapi.json GET /v1/flows
openapi: 3.1.0
info:
  title: Pilot Status API
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    Public REST API for Pilot Status. Authenticate with the `x-api-key: ps_...`
    header (or `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/flows:
    get:
      tags:
        - Flows
      summary: List Flows
      description: >-
        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`.
      operationId: get_flows
      parameters:
        - name: page
          in: query
          required: false
          description: Page number, 1-based.
          schema:
            type: integer
            minimum: 1
            default: 1
          example: 1
        - name: pageSize
          in: query
          required: false
          description: Rows per page. Default 30, maximum 100.
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 30
          example: 30
      responses:
        '200':
          description: List Flows
          content:
            application/json:
              example:
                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
        '400':
          description: Pagination too deep (`page` × `pageSize` past the ceiling)
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Portuguese half
                  errorEN:
                    type: string
                    description: English half
                  code:
                    type: string
              example:
                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
        '401':
          description: Missing or invalid `x-api-key` / `x-api-key-id` header
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '403':
          description: >-
            Tenant-scoped key used on a number-scoped endpoint, or the key's
            role lacks the permission
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Tenant-scoped keys cannot call number endpoints
                code: TENANT_SCOPE_NOT_ALLOWED
        '422':
          description: >-
            The key's number is not a Meta (Cloud API) number, or has no WABA
            behind it
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Portuguese half
                  errorEN:
                    type: string
                    description: English half
                  code:
                    type: string
              example:
                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
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Too many requests
        '500':
          description: >-
            Internal error. Never carries the internal message — that belongs in
            the log
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Portuguese half
                  errorEN:
                    type: string
                    description: English half
                  code:
                    type: string
              example:
                error: Erro interno do servidor.
                errorEN: Internal server error.
                code: INTERNAL_ERROR
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Your ps_ API key
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: API key id (alternative to x-api-key)

````