Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

D toc

Returns a list of all flows accessible to the authenticated user.

Version: v3

Required Permissions

  • If you are not logged in or are logged as a non-admin user, you can retrieve only your flows.
  • If you are logged in as an admin, you can retrieve all flows in the platform.

D s api auth

Request

Request Type: GET

Endpoint:

Code Block
/v3/flows

Endpoint with paged retrieval:


By default, this endpoint returns results in sets of 25. 

You can apply query parameters to change the size of the default set and to page through result sets. The following example queries for results 100 at a time. In this case, the query asks for results 201-300:

Code Block
/v3/flows?limit=100%offset=2

If the count of retrieved results is less than the limit, you have reached the end of the results.


Request Body:

Empty.

Response

Response Status Code - Success: 200 - OK

Response Body Examples:

Code Block
[
    {
        "id": 7,
        "name": "USDA_Farmers_Market_2014 Flow",
        "description": null,
        "deleted_at": null,
        "cpProject": null,
        "createdAt": "2017-11-07T19:30:29.296Z",
        "updatedAt": "2017-11-07T19:30:29.296Z",
        "createdBy": 1,
        "updatedBy": 1,
        "associatedPeople": [
            {
                "outputHomeDir": "/trifacta/queryResults/admin@trifacta.local",
                "name": "Administrator",
                "email": "admin@trifacta.local",
                "id": 1,
                "flowpermission": {
                    "flowId": 7,
                    "personId": 1,
                    "role": "owner"
                }
            }
        ]
    },
    {
        "id": 3,
        "name": "2013 POS",
        "description": null,
        "deleted_at": null,
        "cpProject": null,
        "createdAt": "2017-11-07T17:02:34.662Z",
        "updatedAt": "2017-11-07T17:02:34.662Z",
        "createdBy": 1,
        "updatedBy": 1,
        "associatedPeople": [
            {
                "outputHomeDir": "/trifacta/queryResults/admin@trifacta.local",
                "name": "Administrator",
                "email": "admin@trifacta.local",
                "id": 1,
                "flowpermission": {
                    "flowId": 3,
                    "personId": 1,
                    "role": "owner"
                }
            }
        ]
    }
]


Reference

For more information on the properties of a user, see API Flows Get v3.