curl --request GET \
--url https://api.paigeme.dev/v1/flows/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.paigeme.dev/v1/flows/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.paigeme.dev/v1/flows/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"data": {
"flow": {
"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>",
"definition": {}
}
}
}{
"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>"
}{
"success": false,
"error": {
"code": "invalid_request",
"message": "Invalid request body",
"details": {}
},
"request_id": "<string>"
}Read one flow, including its JSON definition
{id} is the flow NAME (the same identity PATCH /v1/flows/{id} takes), not the row id. Adds definition — the flow JSON itself — to the summary shape. definition is null if the stored JSON is unreadable; the metadata is still returned.
Required scope: flows:read
curl --request GET \
--url https://api.paigeme.dev/v1/flows/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.paigeme.dev/v1/flows/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.paigeme.dev/v1/flows/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"data": {
"flow": {
"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>",
"definition": {}
}
}
}{
"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>"
}{
"success": false,
"error": {
"code": "invalid_request",
"message": "Invalid request body",
"details": {}
},
"request_id": "<string>"
}Authorizations
Project API key issued in Settings → API keys. Send it as Authorization: Bearer pk_live_….
Headers
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).
Path Parameters
Response
Success.
true Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
The flow identity — this is the {id} other flow endpoints take.
DRAFT | PUBLISHED | DEPRECATED | BLOCKED | THROTTLED | LOCAL.
Where the JSON lives in project files, e.g. flows/booking.json.
True when the flow declares a data endpoint.
Flow id on the user's own WABA, or null when not connected.
State of the Paige Dev shared-number copy: NONE | PUBLISHED | DEPRECATED.
The flow JSON (screens, routing, data model), or null when unparseable.
Was this page helpful?
