Page tree

 

As of Release 6.4, the v3 APIs are End of Life (EOL). Before using this release or a later one, you should migrate to using the latest available API version. For more information, see API Version Support Matrix.
Latest version of this endpoint: API Flows Get List v4.

Contents:


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.

NOTE: Each request to the Trifacta® platform must include authentication credentials. See API Authentication.

Request

Request Type: GET

Endpoint:

/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 3-102:

/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:

[
    {
        "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/joe@example.com",
                "name": "Administrator",
                "email": "joe@example.com",
                "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/joe@example.com",
                "name": "Administrator",
                "email": "joe@example.com",
                "id": 1,
                "flowpermission": {
                    "flowId": 3,
                    "personId": 1,
                    "role": "owner"
                }
            }
        ]
    }
]


Reference

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

 

This page has no comments.