List the project's WhatsApp Flows

curl --request GET \
  --url https://api.paigeme.dev/v1/flows \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paigeme.dev/v1/flows', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.paigeme.dev/v1/flows"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "flows": [
      {
        "id": "<string>",
        "name": "<string>",
        "status": "<string>",
        "categories": [
          "<string>"
        ],
        "file_path": "<string>",
        "first_screen": "<string>",
        "is_dynamic": true,
        "validation_errors": [
          {}
        ],
        "meta_flow_id": "<string>",
        "paige_status": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>"
      }
    ]
  }
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

GET

flows

List the project's WhatsApp Flows

curl --request GET \
  --url https://api.paigeme.dev/v1/flows \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paigeme.dev/v1/flows', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.paigeme.dev/v1/flows"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "flows": [
      {
        "id": "<string>",
        "name": "<string>",
        "status": "<string>",
        "categories": [
          "<string>"
        ],
        "file_path": "<string>",
        "first_screen": "<string>",
        "is_dynamic": true,
        "validation_errors": [
          {}
        ],
        "meta_flow_id": "<string>",
        "paige_status": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>"
      }
    ]
  }
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

Authorizations

Authorization

string

header

required

Project API key issued in Settings → API keys. Send it as Authorization: Bearer pk_live_….

Headers

X-Paige-Project

string

Target project id, for an MCP OAuth bearer (mcp_at_…) attached to more than one project — get ids from GET /v1/projects. Matched case-insensitively.

Omit it and a READ falls back to the connection's default project; a mutation (any non-GET) on a connection with 2+ projects is rejected with 400 project_required — a write is never defaulted to a guessed project. A connection with exactly one project never needs the header.

Scopes are checked against the SELECTED project only, never a union across the connection.

For a pk_ API key the header selects nothing — one key is one project's context — but it IS validated: omit it and the key's own project is used, send it and it must name that project, otherwise the call is rejected with 403 project_not_attached (a blank value is 400 invalid_project_header, as above).

Response

Success.

success

enum<boolean>

required

Available options:

true

data

object

required

Hide child attributes

data.flows

object[]

required

Hide child attributes

data.flows.id

string

required

data.flows.name

string

required

The flow identity — this is the {id} other flow endpoints take.

data.flows.status

string

required

data.flows.categories

string[]

required

data.flows.file_path

string | null

required

Where the JSON lives in project files, e.g. flows/booking.json.

data.flows.first_screen

string | null

required

data.flows.is_dynamic

boolean

required

True when the flow declares a data endpoint.

data.flows.validation_errors

object[]

required

data.flows.meta_flow_id

string | null

required

Flow id on the user's own WABA, or null when not connected.

data.flows.paige_status

string

required

State of the Paige Dev shared-number copy: NONE | PUBLISHED | DEPRECATED.

data.flows.created_at

string

required

data.flows.updated_at

string

required

Promote dev → production Generate a new WhatsApp Flow via the flows sub-agent

Getting started

Endpoints

List the project's WhatsApp Flows

Authorizations

Headers

Response