curl --request GET \
--url https://api.privy.com/v1/flows/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.privy.com/v1/flows/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.privy.com/v1/flows/{id}', 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://api.privy.com/v1/flows/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://api.privy.com/v1/flows/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.privy.com/v1/flows/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.privy.com/v1/flows/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "Vq7L3mN9xR",
"title": "Abandoned Cart Recovery",
"status": "active",
"trigger_type": "cart_abandoned",
"trigger_label": "Cart abandoned",
"reentry": {
"mode": "after_delay",
"frequency": 30,
"unit": "days"
},
"flow_filters": {
"operation": "AND",
"conditions": [
{
"property": "channel",
"operator": "equals",
"value": "email"
},
{
"property": "segment",
"operator": "contains",
"value": [
"Nk2P5rW8yU"
]
}
]
},
"exit_behavior": {
"exit_events": [
"order_placed",
"order_delivered"
],
"applies_to": "active_journeys_only",
"enrollment_event_excluded": true,
"summary": "After enrollment, a subsequent order placed or order delivered event ends the journey early. The event that enrolled the contact never triggers this exit."
},
"behavior_summary": "A contact enrolls when the \"Cart abandoned\" event occurs. The flow has 2 message steps. A subsequent order placed or order delivered event ends an active journey early; the event that enrolled the contact never triggers this exit. A contact can re-enter 30 days after their previous journey ends; no setting ever runs two journeys at once.",
"nodes": [
{
"uuid": "6f1e8d0a-4b2c-4c1d-9a3e-2f5b7c8d9e0f",
"type": "delay",
"name": "Wait 1 hour",
"parent_uuid": null,
"next_uuid": "8b3c0f2d-6d4e-4e3f-9c5a-4b7d9e0f1a2b",
"data": {
"delay_unit": "hours",
"delay_unit_count": 1
}
},
{
"uuid": "8b3c0f2d-6d4e-4e3f-9c5a-4b7d9e0f1a2b",
"type": "split",
"name": "High-value cart?",
"parent_uuid": "6f1e8d0a-4b2c-4c1d-9a3e-2f5b7c8d9e0f",
"yes_next_uuid": "7a2f9e1b-5c3d-4d2e-8b4f-3a6c8d9e0f1a",
"no_next_uuid": "9c4d1a3e-7e5f-4f4a-8d6b-5c8e0f1a2b3c",
"data": {
"conditions": {
"operation": "AND",
"conditions": [
{
"property": "abandoned_cart_value",
"operator": "greater_than",
"value": 100
}
]
}
}
},
{
"uuid": "7a2f9e1b-5c3d-4d2e-8b4f-3a6c8d9e0f1a",
"type": "email",
"name": "VIP cart reminder",
"parent_uuid": "8b3c0f2d-6d4e-4e3f-9c5a-4b7d9e0f1a2b",
"next_uuid": null,
"data": {
"campaign_id": "Xk4M7pQ2wT",
"subject": "You left something behind!"
}
},
{
"uuid": "9c4d1a3e-7e5f-4f4a-8d6b-5c8e0f1a2b3c",
"type": "sms",
"name": "Cart reminder text",
"parent_uuid": "8b3c0f2d-6d4e-4e3f-9c5a-4b7d9e0f1a2b",
"next_uuid": null,
"data": {
"campaign_id": "Zt6N1rV4yU",
"message_body": "Your cart is waiting — checkout now and save 10%."
}
}
],
"sync_coupons": false,
"last_transition_at": "2026-06-01T12:00:00Z"
}
}{
"error": {
"code": "unauthorized",
"message": "Bearer token is missing or invalid"
}
}{
"error": {
"code": "insufficient_scope",
"message": "Token does not have the required scope"
}
}{
"error": {
"code": "not_found",
"message": "Not found"
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded"
}
}Get a flow
Retrieve a single flow by its identifier, including its full
configuration: re-entry behavior, flow filters, effective exit
behavior, a server-generated behavior summary, and the node tree —
each step’s configuration (data) plus the branch graph, with split
conditions and the nodes on each branch.
exit_behavior and reentry state the engine’s effective semantics
directly: exits end only journeys already in progress (the enrolling
event never triggers them), and reentry.mode says explicitly
whether and when a contact can go through again. Trust these fields
and behavior_summary over inferences from the node structure.
Required scope: flows_read
curl --request GET \
--url https://api.privy.com/v1/flows/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.privy.com/v1/flows/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.privy.com/v1/flows/{id}', 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://api.privy.com/v1/flows/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://api.privy.com/v1/flows/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.privy.com/v1/flows/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.privy.com/v1/flows/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "Vq7L3mN9xR",
"title": "Abandoned Cart Recovery",
"status": "active",
"trigger_type": "cart_abandoned",
"trigger_label": "Cart abandoned",
"reentry": {
"mode": "after_delay",
"frequency": 30,
"unit": "days"
},
"flow_filters": {
"operation": "AND",
"conditions": [
{
"property": "channel",
"operator": "equals",
"value": "email"
},
{
"property": "segment",
"operator": "contains",
"value": [
"Nk2P5rW8yU"
]
}
]
},
"exit_behavior": {
"exit_events": [
"order_placed",
"order_delivered"
],
"applies_to": "active_journeys_only",
"enrollment_event_excluded": true,
"summary": "After enrollment, a subsequent order placed or order delivered event ends the journey early. The event that enrolled the contact never triggers this exit."
},
"behavior_summary": "A contact enrolls when the \"Cart abandoned\" event occurs. The flow has 2 message steps. A subsequent order placed or order delivered event ends an active journey early; the event that enrolled the contact never triggers this exit. A contact can re-enter 30 days after their previous journey ends; no setting ever runs two journeys at once.",
"nodes": [
{
"uuid": "6f1e8d0a-4b2c-4c1d-9a3e-2f5b7c8d9e0f",
"type": "delay",
"name": "Wait 1 hour",
"parent_uuid": null,
"next_uuid": "8b3c0f2d-6d4e-4e3f-9c5a-4b7d9e0f1a2b",
"data": {
"delay_unit": "hours",
"delay_unit_count": 1
}
},
{
"uuid": "8b3c0f2d-6d4e-4e3f-9c5a-4b7d9e0f1a2b",
"type": "split",
"name": "High-value cart?",
"parent_uuid": "6f1e8d0a-4b2c-4c1d-9a3e-2f5b7c8d9e0f",
"yes_next_uuid": "7a2f9e1b-5c3d-4d2e-8b4f-3a6c8d9e0f1a",
"no_next_uuid": "9c4d1a3e-7e5f-4f4a-8d6b-5c8e0f1a2b3c",
"data": {
"conditions": {
"operation": "AND",
"conditions": [
{
"property": "abandoned_cart_value",
"operator": "greater_than",
"value": 100
}
]
}
}
},
{
"uuid": "7a2f9e1b-5c3d-4d2e-8b4f-3a6c8d9e0f1a",
"type": "email",
"name": "VIP cart reminder",
"parent_uuid": "8b3c0f2d-6d4e-4e3f-9c5a-4b7d9e0f1a2b",
"next_uuid": null,
"data": {
"campaign_id": "Xk4M7pQ2wT",
"subject": "You left something behind!"
}
},
{
"uuid": "9c4d1a3e-7e5f-4f4a-8d6b-5c8e0f1a2b3c",
"type": "sms",
"name": "Cart reminder text",
"parent_uuid": "8b3c0f2d-6d4e-4e3f-9c5a-4b7d9e0f1a2b",
"next_uuid": null,
"data": {
"campaign_id": "Zt6N1rV4yU",
"message_body": "Your cart is waiting — checkout now and save 10%."
}
}
],
"sync_coupons": false,
"last_transition_at": "2026-06-01T12:00:00Z"
}
}{
"error": {
"code": "unauthorized",
"message": "Bearer token is missing or invalid"
}
}{
"error": {
"code": "insufficient_scope",
"message": "Token does not have the required scope"
}
}{
"error": {
"code": "not_found",
"message": "Not found"
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded"
}
}Authorizations
Send either an API token or an OAuth access token as
Authorization: Bearer <token>. See the Authentication page for details.
Headers
Target a subaccount instead of the main connected account.
Pass a subaccount id from get_account's subaccounts list. Only direct subaccounts
of the connected account are reachable — omit this for the main account itself.
Path Parameters
The flow's unique identifier (returned as id in flow responses). Ids are opaque public strings — a numeric id from a Privy dashboard URL is not a valid API id and will 404; list flows and match by title instead.
Response
The flow.
Show child attributes
Show child attributes
Was this page helpful?