Get workflows

GET
/api/v2/projects/:projectKey/flags/:featureFlagKey/environments/:environmentKey/workflows

Display workflows associated with a feature flag.

Path parameters

projectKeystringRequired

The project key

featureFlagKeystringRequired

The feature flag key

environmentKeystringRequired

The environment key

Query parameters

statusstringOptional

Filter results by workflow status. Valid status filters are active, completed, and failed.

sortstringOptional

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.

limitlongOptional

The maximum number of workflows to return. Defaults to 20.

offsetlongOptional

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

itemslist of objects

An array of workflows

totalCountinteger

Total number of workflows

Errors

Built with