PRprivy
Flows

List flows

Changed on

Retrieve a paginated list of your automation flows, including each flow's trigger and steps. Use GET /v1/flows/{id} for a flow's full configuration — entry frequency, flow filters, exit criteria, and the node branch graph.

Configuration only — no performance, and no membership. Flow results and the live enrollment count both come from /v1/reports/flows, which lists every flow, so pair the two rather than expecting stats here.

Required scope: flows_read

get/flows

Request

  • Base URL
    https://api.privy.com/v1
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number (starts at 1).

per_pageinteger

Number of results per page. Values outside 10–100 are clamped to the nearest bound.

status'draft' | 'active' | 'inactive'

Filter by flow status.

Headers

Privy-Account-Idstring

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.

Response

A paginated list of flows.

Example response

{
  "data": [
    {
      "id": "Vq7L3mN9xR",
      "title": "Abandoned Cart Recovery",
      "status": "active",
      "trigger_type": "cart_abandoned",
      "trigger_label": "Cart abandoned",
      "nodes": [
        {
          "uuid": "6f1e8d0a-4b2c-4c1d-9a3e-2f5b7c8d9e0f",
          "type": "email",
          "name": "Welcome email"
        }
      ],
      "last_transition_at": "2026-06-01T12:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total_count": 142,
    "total_pages": 6
  }
}

Changes

  • cf0885e90d5aRevision changes
    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new segment_builder_required enum value to the / response property for the response status

    • warning

      added the new segment_builder_required enum value to the / response property for the response status

    • warning

      added the new segment_builder_required enum value to the / response property for the response status

    • warning

      added the new segment_builder_required enum value to the / response property for the response status

  • fe500ab59b3bRevision changes
    • info

      endpoint added