Get workflow templates

GET

/api/v2/templates

Get workflow templates belonging to an account, or can optionally return templates_endpoints.workflowTemplateSummariesListingOutputRep when summary query param is true

Query parameters

summarybooleanOptional

Whether the entire template object or just a summary should be returned

searchstringOptional

The substring in either the name or description of a template

Response

Workflow templates list response JSON

itemslist of objects

Errors

GET

1 curl https://app.launchdarkly.com/api/v2/templates \
2      -H "Authorization: <apiKey>"

200Retrieved

1 {
2   "items": [
3     {
4       "_id": "_id",
5       "_key": "_key",
6       "_creationDate": 1000000,
7       "_ownerId": "_ownerId",
8       "_maintainerId": "_maintainerId",
9       "_links": {
10         "key": {}
11       },
12       "name": "name",
13       "description": "description",
14       "stages": [
15         {
16           "_id": "12ab3c45de678910abc12345",
17           "conditions": [
18             {
19               "_id": "_id",
20               "_execution": {
21                 "status": "completed"
22               },
23               "description": "description",
24               "notifyMemberIds": [
25                 "notifyMemberIds"
26               ],
27               "allReviews": [
28                 {
29                   "_id": "_id",
30                   "kind": "kind"
31                 }
32               ],
33               "reviewStatus": "reviewStatus",
34               "kind": "schedule",
35               "scheduleKind": "relative",
36               "waitDuration": 2,
37               "waitDurationUnit": "calendarDay"
38             }
39           ],
40           "action": {
41             "kind": "patch",
42             "instructions": [
43               {
44                 "key": "value"
45               }
46             ]
47           },
48           "_execution": {
49             "status": "completed"
50           },
51           "name": "10% rollout on day 1"
52         }
53       ]
54     }
55   ]
56 }

Other

Up Next

Built with

1	curl https://app.launchdarkly.com/api/v2/templates \
2	-H "Authorization: <apiKey>"

1	{
2	"items": [
3	{
4	"_id": "_id",
5	"_key": "_key",
6	"_creationDate": 1000000,
7	"_ownerId": "_ownerId",
8	"_maintainerId": "_maintainerId",
9	"_links": {
10	"key": {}
11	},
12	"name": "name",
13	"description": "description",
14	"stages": [
15	{
16	"_id": "12ab3c45de678910abc12345",
17	"conditions": [
18	{
19	"_id": "_id",
20	"_execution": {
21	"status": "completed"
22	},
23	"description": "description",
24	"notifyMemberIds": [
25	"notifyMemberIds"
26	],
27	"allReviews": [
28	{
29	"_id": "_id",
30	"kind": "kind"
31	}
32	],
33	"reviewStatus": "reviewStatus",
34	"kind": "schedule",
35	"scheduleKind": "relative",
36	"waitDuration": 2,
37	"waitDurationUnit": "calendarDay"
38	}
39	],
40	"action": {
41	"kind": "patch",
42	"instructions": [
43	{
44	"key": "value"
45	}
46	]
47	},
48	"_execution": {
49	"status": "completed"
50	},
51	"name": "10% rollout on day 1"
52	}
53	]
54	}
55	]
56	}