API Flows Get List v4

Release 6.4.2

Contents:

Expand all Collapse all

For the latest updates on available API endpoints and documentation, see api.trifacta.com.

This is the latest version of the APIs.

Contents:

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

Version: v4

Required Permissions

When authenticated, you can review all flows to which you have access.

NOTE: Each request to the Designer Cloud Powered by Trifacta® platform must include authentication credentials. See https://api.trifacta.com/ee/6.4/index.html#section/Authentication.

Request

Request Type: GET

Endpoint:

/v4/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 2-102:

/v4/flows?limit=100&offset=2

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

Query Parameter reference:

The following query parameters are supported for this type of endpoint.

Query Parameter	Data Type	Description
embed	string	Comma-separated list of objects to include part of the response.
includeDeleted	string	If set to `true`, response includes deleted objects.
limit	integer	Maximum number of objects to fetch. Default: `25`.
noLimit	string	If set to `true`, response does not limit the number of objects.
offset	integer	Offset after which to start returning objects. For use with `limit` query parameter.
sort	string	Defines sort order for returned objects.
filterFields	string	Comma-separated list of fields against which to match the `filter` parameter. Default: `name`
filter	string	Value for fuzzy-filtering objects. See `filterFields` .
flowNodeId	integer	(some endpoints) Internal value. Do not modify.
sharedRole	string	(some endpoints) The role type required to list the connection
flowFilter	string	(some endpoints) The type of flows to list. Values: `all`, `shared`, `owned`

For more information, see API Common Query Parameters v4.

Request Body:

Empty.

Response

Response Status Code - Success: 200 - OK

Response Body Examples:

{
    "data": [
        {
            "id": 9,
            "name": "Intern Training",
            "description": "(Please don't modify)",
            "createdAt": "2019-01-08T18:14:37.851Z",
            "updatedAt": "2019-01-08T18:57:26.824Z",
            "creator": {
                "id": 1
            },
            "updater": {
                "id": 1
            },
            "folder": {
                "id": 1
            }
            "workspace": {
                "id": 1
            }
        },
        {
            "id": 6,
            "name": "2013 POS",
            "description": null,
            "createdAt": "2019-01-08T17:25:21.392Z",
            "updatedAt": "2019-01-08T17:30:30.959Z",
            "creator": {
                "id": 1
            },
            "updater": {
                "id": 1
            },
            "folder": {
                "id": 4
            }
            "workspace": {
                "id": 1
            }
        },
        {
            "id": 3,
            "name": "Untitled Flow",
            "description": "",
            "createdAt": "2019-01-08T15:53:51.109Z",
            "updatedAt": "2019-01-08T16:10:10.020Z",
            "creator": {
                "id": 1
            },
            "updater": {
                "id": 1
            },
            "folder": null,
            "workspace": {
                "id": 1
            }
        }
    ]
}

Reference

For more information on the properties of a flow see API Flows Get v4.

Send Feedback

Page tree

API Flows Get List v4

Required Permissions

Request

Response

Reference