v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB

Workflows

Get custom workflow

Get a specific workflow by ID.

get/api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows/{workflowId}

Path parameters

projectKeystring string required

The project key

featureFlagKeystring string required

The feature flag key

environmentKeystring string required

The environment key

workflowIdstring string required

The workflow ID

Response

Workflow response

_idstring required

The ID of the workflow

_versioninteger required

The version of the workflow

_creationDateinteger required

_maintainerIdstring required

The member ID of the maintainer of the workflow. Defaults to the workflow creator.

_linksobject required

The location and content type of related resources

namestring required

The name of the workflow

descriptionstring

A brief description of the workflow

kindstring

The kind of workflow

templateKeystring

For workflows being created from a workflow template, this value is the template's key

Example response

{
  "_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"
}