Page tree

Outdated release! Latest docs are Release 8.7: API Flows Get v3


For the latest updates on available API endpoints and documentation, see


Retrieve the flow information for a specified flow identifier.  

Version: v3

Required Permissions

The authenticated user must be an admin.

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


Request Type: GET


<id>Internal identifier of the flow to retrieve.

Request URI - Example:


Request Body:



Response Status Code - Success:  200 - OK

Response Body Example:

        "id": 10,
        "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"


idInternal identifier for the flow
nameDisplay text for the flow
descriptionUser-friendly description for the flow
cpProjectNot used.
createdAtTimestamp for when the flow was created
updatedAtTimestamp for when the flow was last modified
createdByInternal identifier of the user who created the flow
updatedByInternal identifier of the user who last updated the flow
associatedPeople.outputHomeDirOutput directory for the associated person.
associatedPeople.nameName of the associated person.
associatedPeople.emailUser ID (email address) of the associated person.
associatedPeople.idInternal ID for the associated person.
associatedPeople.flowpermission.flowIdInternal ID for the flow.
associatedPeople.flowpermission.personIdInternal ID for the permitted user.

Role for the permitted user.

  • owner - can do anything to the flow.
  • collaborator - can do most actions on the flow except change the name and delete the flow.



This page has no comments.