This endpoint allows you to list flows in your account.

Listing Flows

A GET returns the list of flows for your organization, in the order of last created.

• uuid - the UUID of the flow (string), filterable as uuid.
• name - the name of the flow (string).
• type - the type of the flow (one of "message", "voice", "survey"), filterable as type.
• archived - whether this flow is archived (boolean), filterable as archived.
• labels - the labels for this flow (array of objects).
• expires - the time (in minutes) when this flow's inactive contacts will expire (integer).
• runs - the counts of active, completed, interrupted and expired runs (object).
• results - the results that this flow may create (array).
• parent_refs - the keys of the parent flow results referenced in this flow (array).
• created_on - when this flow was created (datetime).
• modified_on - when this flow was last modified (datetime), filterable as before and after.

Example:

GET /api/v2/flows.json

Response containing the flows for your organization:

{
    "next": null,
    "previous": null,
    "results": [
        {
            "uuid": "5f05311e-8f81-4a67-a5b5-1501b6d6496a",
            "name": "Survey",
            "type": "message",
            "archived": false,
            "labels": [{"name": "Important", "uuid": "5a4eb79e-1b1f-4ae3-8700-09384cca385f"}],
            "expires": 600,
            "runs": {
                "active": 47,
                "completed": 123,
                "interrupted": 2,
                "expired": 34
            },
            "results": [
                {
                    "key": "has_water",
                    "name": "Has Water",
                    "categories": ["Yes", "No", "Other"],
                    "node_uuids": ["99afcda7-f928-4d4a-ae83-c90c96deb76d"]
                }
            ],
            "parent_refs": [],
            "created_on": "2016-01-06T15:33:00.813162Z",
            "modified_on": "2017-01-07T13:14:00.453567Z"
        },
        ...
    ]
}