Flows
List Flows
List all flows that exist in Directus.
Query Parameters
Control what fields are being returned in the object.
A limit on the number of objects that are returned.
How many items to skip when fetching data.
How to sort the returned items. sort is a CSV of fields used to sort the fetched items. Sorting defaults to ascending (ASC) order but a minus sign (-) can be used to reverse this to descending (DESC) order. Fields are prioritized by their order in the CSV. You can also use a ? to sort randomly.
Select items in collection by given conditions.
Filter by items that contain the given search query in one of their fields.
What metadata to return in the response.
GET /flows
{
"data": [
{
"id": "2f24211d-d928-469a-aea3-3c8f53d4e426",
"name": "Update Articles Flow",
"icon": "bolt",
"color": null,
"status": "active",
"trigger": "manual",
"accountability": "$trigger",
"options": null,
"operation": "92e82998-e421-412f-a513-13701e83e4ce",
"date_created": "2022-05-11T13:14:52Z",
"user_created": "63716273-0f29-4648-8a2a-2af2948f6f78",
"operations": []
}
],
"meta": {}
}
Create Multiple Flows
Create multiple new flows.
Query Parameters
Control what fields are being returned in the object.
A limit on the number of objects that are returned.
What metadata to return in the response.
How many items to skip when fetching data.
How to sort the returned items. sort is a CSV of fields used to sort the fetched items. Sorting defaults to ascending (ASC) order but a minus sign (-) can be used to reverse this to descending (DESC) order. Fields are prioritized by their order in the CSV. You can also use a ? to sort randomly.
Select items in collection by given conditions.
Filter by items that contain the given search query in one of their fields.
Request Body
POST /flows
{
"data": [
{
"id": "2f24211d-d928-469a-aea3-3c8f53d4e426",
"name": "Update Articles Flow",
"icon": "bolt",
"color": null,
"status": "active",
"trigger": "manual",
"accountability": "$trigger",
"options": null,
"operation": "92e82998-e421-412f-a513-13701e83e4ce",
"date_created": "2022-05-11T13:14:52Z",
"user_created": "63716273-0f29-4648-8a2a-2af2948f6f78",
"operations": []
}
],
"meta": {}
}
Delete Multiple Flows
Delete multiple existing flows.
DELETE /flows
Update Multiple Flows
Update multiple flows at the same time.
Query Parameters
Control what fields are being returned in the object.
A limit on the number of objects that are returned.
What metadata to return in the response.
How many items to skip when fetching data.
How to sort the returned items. sort is a CSV of fields used to sort the fetched items. Sorting defaults to ascending (ASC) order but a minus sign (-) can be used to reverse this to descending (DESC) order. Fields are prioritized by their order in the CSV. You can also use a ? to sort randomly.
Select items in collection by given conditions.
Filter by items that contain the given search query in one of their fields.
Request Body
PATCH /flows
{
"data": [
{
"id": "2f24211d-d928-469a-aea3-3c8f53d4e426",
"name": "Update Articles Flow",
"icon": "bolt",
"color": null,
"status": "active",
"trigger": "manual",
"accountability": "$trigger",
"options": null,
"operation": "92e82998-e421-412f-a513-13701e83e4ce",
"date_created": "2022-05-11T13:14:52Z",
"user_created": "63716273-0f29-4648-8a2a-2af2948f6f78",
"operations": []
}
],
"meta": {}
}
Create a Flow
Create a new flow.
Query Parameters
Control what fields are being returned in the object.
What metadata to return in the response.
Request Body
POST /flows
{
"data": {
"id": "2f24211d-d928-469a-aea3-3c8f53d4e426",
"name": "Update Articles Flow",
"icon": "bolt",
"color": null,
"status": "active",
"trigger": "manual",
"accountability": "$trigger",
"options": null,
"operation": "92e82998-e421-412f-a513-13701e83e4ce",
"date_created": "2022-05-11T13:14:52Z",
"user_created": "63716273-0f29-4648-8a2a-2af2948f6f78",
"operations": []
}
}
Retrieve a Flow
Retrieve a single flow by primary key.
Query Parameters
Unique identifier for the object.
GET /flows/{id}
{
"data": {
"id": "2f24211d-d928-469a-aea3-3c8f53d4e426",
"name": "Update Articles Flow",
"icon": "bolt",
"color": null,
"status": "active",
"trigger": "manual",
"accountability": "$trigger",
"options": null,
"operation": "92e82998-e421-412f-a513-13701e83e4ce",
"date_created": "2022-05-11T13:14:52Z",
"user_created": "63716273-0f29-4648-8a2a-2af2948f6f78",
"operations": []
}
}
DELETE /flows/{id}
Update a Flow
Update an existing flow.
Query Parameters
Unique identifier for the object.
Control what fields are being returned in the object.
What metadata to return in the response.
Request Body
PATCH /flows/{id}
{
"data": {
"id": "2f24211d-d928-469a-aea3-3c8f53d4e426",
"name": "Update Articles Flow",
"icon": "bolt",
"color": null,
"status": "active",
"trigger": "manual",
"accountability": "$trigger",
"options": null,
"operation": "92e82998-e421-412f-a513-13701e83e4ce",
"date_created": "2022-05-11T13:14:52Z",
"user_created": "63716273-0f29-4648-8a2a-2af2948f6f78",
"operations": []
}
}
Flow with GET webhook trigger
Start a flow with GET webhook trigger.
Query Parameters
Identifier for the object.
Control what fields are being returned in the object.
What metadata to return in the response.
GET /flows/trigger/{id}
{}
Flow with POST webhook trigger
Start a flow with POST webhook trigger.
Query Parameters
Identifier for the object.
Control what fields are being returned in the object.
What metadata to return in the response.
POST /flows/trigger/{id}
{}