Get workflows
Display workflows associated with a feature flag.
Path parameters
The project key
The project key
The feature flag key
The feature flag key
The environment key
The environment key
Query parameters
Filter results by workflow status. Valid status filters are active, completed, and failed.
Filter results by workflow status. Valid status filters are active, completed, and failed.
A field to sort the items by. Prefix field by a dash ( - ) to sort in descending order. This endpoint supports sorting by creationDate or stopDate.
A field to sort the items by. Prefix field by a dash ( - ) to sort in descending order. This endpoint supports sorting by creationDate or stopDate.
The maximum number of workflows to return. Defaults to 20.
The maximum number of workflows to return. Defaults to 20.
Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit.
Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit.
Response
Workflows collection response
Example response
{
"items": [
{
"_id": "12ab3c4d5ef1a2345bcde67f",
"_version": 1,
"_conflicts": [
{
"stageId": "12ab3c4d5ef1a2345bcde67f"
}
],
"_maintainerId": "12ab3c45de678910abc12345",
"name": "Progressive rollout starting in two days",
"description": "Turn flag on for 10% of customers each day",
"kind": "custom",
"stages": [
{
"_id": "12ab3c45de678910abc12345",
"name": "10% rollout on day 1",
"conditions": [
{
"_execution": {
"status": "completed"
},
"id": "12ab3c45de678910abc12345",
"kind": "schedule",
"scheduleKind": "relative",
"waitDuration": 2,
"waitDurationUnit": "calendarDay"
}
],
"action": {
"kind": "patch"
},
"_execution": {
"status": "completed"
}
}
],
"_execution": {
"status": "completed"
},
"templateKey": "example-workflow-template"
}
],
"totalCount": 1
}