POST /v1/actions/get-flow

Fetch a flow by id with its name, trigger type, publish state, and lifetime session count.

Fetches a flow by id. Returns its name, trigger type, publish state, and lifetime session count.

POST /api/v1/actions/get-flow

Request body

Field Type Required
flow_id UUID yes
curl -X POST https://www.qyvo.io/api/v1/actions/get-flow \
  -H "Authorization: Bearer YOUR_TOKEN_HERE" \
  -H "Content-Type: application/json" \
  -d '{"flow_id": "01J3F..."}'
const flow = await fetch('https://www.qyvo.io/api/v1/actions/get-flow', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.QYVO_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ flow_id: '01J3F...' }),
}).then((r) => r.json());
$flow = Http::withToken(env('QYVO_TOKEN'))
    ->post('https://www.qyvo.io/api/v1/actions/get-flow', [
        'flow_id' => '01J3F...',
    ])
    ->json();
import os, httpx
flow = httpx.post(
    'https://www.qyvo.io/api/v1/actions/get-flow',
    headers={'Authorization': f"Bearer {os.environ['QYVO_TOKEN']}"},
    json={'flow_id': '01J3F...'},
).json()

Response — 200 OK

{
  "id": "01J3F...",
  "name": "Abandoned cart 30min",
  "status": "published",
  "trigger_type": "shopify_cart_abandoned",
  "sessions_count": 4218,
  "published_at": "2026-04-15T10:32:00+00:00",
  "created_at": "2026-04-14T09:00:00+00:00"
}
Field Values
status draft (no published_at) or published
trigger_type What kicks the flow off automatically: manual, shopify_cart_abandoned, shopify_order_placed, keyword, widget, webhook, …