Returns a list of all flows accessible to the authenticated user.
Version: v4
When authenticated, you can review all flows to which you have access.
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 3-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.
Request Body:
Empty.
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
}
}
]
} |
For more information on the properties of a flow see API Flows Get v4.