Get custom workflow — LaunchDarkly

Get a specific workflow by ID.

Path parameters

projectKeystringRequired

The project key

featureFlagKeystringRequired

The feature flag key

environmentKeystringRequired

The environment key

workflowIdstringRequired

The workflow ID

Response

Workflow response

_idstring

The ID of the workflow

_versioninteger

The version of the workflow

_conflictslist of objects

Any conflicts that are present in the workflow stages

_creationDatelong

Timestamp of when the workflow was created

_maintainerIdstring

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

_linksmap from strings to objects

The location and content type of related resources

namestring

The name of the workflow

_executionobject

The current execution status of the workflow

descriptionstringOptional

A brief description of the workflow

kindstringOptional

The kind of workflow

stageslist of objectsOptional

The stages that make up the workflow. Each stage contains conditions and actions.

metaobjectOptional

For workflows being created from a workflow template, this value holds any parameters that could potentially be incompatible with the current project, environment, or flag

templateKeystringOptional

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

Errors

1 curl https://app.launchdarkly.com/api/v2/projects/projectKey/flags/featureFlagKey/environments/environmentKey/workflows/workflowId \ 2 -H "Authorization: <apiKey>"

1 { 2 "_id": "12ab3c4d5ef1a2345bcde67f", 3 "_version": 1, 4 "_conflicts": [ 5 { 6 "stageId": "12ab3c4d5ef1a2345bcde67f", 7 "message": "message" 8 } 9 ], 10 "_creationDate": 1000000, 11 "_maintainerId": "12ab3c45de678910abc12345", 12 "_links": { 13 "key": { 14 "href": "href", 15 "type": "type" 16 } 17 }, 18 "name": "Progressive rollout starting in two days", 19 "_execution": { 20 "status": "completed", 21 "stopDate": 1000000 22 }, 23 "description": "Turn flag on for 10% of customers each day", 24 "kind": "custom", 25 "stages": [ 26 { 27 "_id": "12ab3c45de678910abc12345", 28 "conditions": [ 29 { 30 "_id": "_id", 31 "_execution": { 32 "status": "completed" 33 }, 34 "description": "description", 35 "notifyMemberIds": [ 36 "notifyMemberIds" 37 ], 38 "allReviews": [ 39 { 40 "_id": "_id", 41 "kind": "kind" 42 } 43 ], 44 "reviewStatus": "reviewStatus", 45 "kind": "schedule", 46 "scheduleKind": "relative", 47 "waitDuration": 2, 48 "waitDurationUnit": "calendarDay" 49 } 50 ], 51 "action": { 52 "kind": "patch", 53 "instructions": [ 54 { 55 "key": "value" 56 } 57 ] 58 }, 59 "_execution": { 60 "status": "completed" 61 }, 62 "name": "10% rollout on day 1" 63 } 64 ], 65 "meta": { 66 "parameters": [ 67 {} 68 ] 69 }, 70 "templateKey": "example-workflow-template" 71 }

1	curl https://app.launchdarkly.com/api/v2/projects/projectKey/flags/featureFlagKey/environments/environmentKey/workflows/workflowId \
2	-H "Authorization: <apiKey>"

1	{
2	"_id": "12ab3c4d5ef1a2345bcde67f",
3	"_version": 1,
4	"_conflicts": [
5	{
6	"stageId": "12ab3c4d5ef1a2345bcde67f",
7	"message": "message"
8	}
9	],
10	"_creationDate": 1000000,
11	"_maintainerId": "12ab3c45de678910abc12345",
12	"_links": {
13	"key": {
14	"href": "href",
15	"type": "type"
16	}
17	},
18	"name": "Progressive rollout starting in two days",
19	"_execution": {
20	"status": "completed",
21	"stopDate": 1000000
22	},
23	"description": "Turn flag on for 10% of customers each day",
24	"kind": "custom",
25	"stages": [
26	{
27	"_id": "12ab3c45de678910abc12345",
28	"conditions": [
29	{
30	"_id": "_id",
31	"_execution": {
32	"status": "completed"
33	},
34	"description": "description",
35	"notifyMemberIds": [
36	"notifyMemberIds"
37	],
38	"allReviews": [
39	{
40	"_id": "_id",
41	"kind": "kind"
42	}
43	],
44	"reviewStatus": "reviewStatus",
45	"kind": "schedule",
46	"scheduleKind": "relative",
47	"waitDuration": 2,
48	"waitDurationUnit": "calendarDay"
49	}
50	],
51	"action": {
52	"kind": "patch",
53	"instructions": [
54	{
55	"key": "value"
56	}
57	]
58	},
59	"_execution": {
60	"status": "completed"
61	},
62	"name": "10% rollout on day 1"
63	}
64	],
65	"meta": {
66	"parameters": [
67	{}
68	]
69	},
70	"templateKey": "example-workflow-template"
71	}