Get approval request

GET

/api/v2/approval-requests/:id

GET

/api/v2/approval-requests/:id

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

Try it

200Retrieved

1 {
2   "_id": "12ab3c45de678910abc12345",
3   "_version": 1,
4   "creationDate": 1000000,
5   "serviceKind": "serviceKind",
6   "reviewStatus": "approved",
7   "allReviews": [
8     {
9       "_id": "12ab3c45de678910abc12345",
10       "kind": "approve",
11       "creationDate": 1000000,
12       "comment": "Approved!",
13       "memberId": "12ab3c45de678910abc12345",
14       "serviceTokenId": "12ab3c45de678910abc12345"
15     }
16   ],
17   "notifyMemberIds": [
18     "1234a56b7c89d012345e678f"
19   ],
20   "status": "pending",
21   "instructions": [
22     {
23       "key": "value"
24     }
25   ],
26   "conflicts": [
27     {
28       "instruction": {
29         "key": "value"
30       },
31       "reason": "reason"
32     }
33   ],
34   "_links": {
35     "key": "value"
36   },
37   "requestorId": "12ab3c45de678910abc12345",
38   "description": "example: request approval from someone",
39   "appliedDate": 1000000,
40   "appliedByMemberId": "1234a56b7c89d012345e678f",
41   "appliedByServiceTokenId": "1234a56b7c89d012345e678f",
42   "executionDate": 1000000,
43   "operatingOnId": "12ab3c45de678910abc12345",
44   "integrationMetadata": {
45     "externalId": "externalId",
46     "externalStatus": {
47       "display": "display",
48       "value": "value"
49     },
50     "externalUrl": "externalUrl",
51     "lastChecked": 1000000
52   },
53   "source": {
54     "key": "source-flag-key-123abc",
55     "version": 1
56   },
57   "customWorkflowMetadata": {
58     "name": "Example workflow name",
59     "stage": {
60       "index": 0,
61       "name": "Stage 1"
62     }
63   },
64   "resourceId": "resourceId",
65   "approvalSettings": {
66     "required": true,
67     "bypassApprovalsForPendingChanges": false,
68     "minNumApprovals": 1,
69     "canReviewOwnRequest": false,
70     "canApplyDeclinedChanges": true,
71     "serviceKind": "launchdarkly",
72     "serviceConfig": {
73       "key": "value"
74     },
75     "requiredApprovalTags": [
76       "require-approval"
77     ],
78     "autoApplyApprovedChanges": true,
79     "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258",
80     "resourceKind": "resourceKind"
81   },
82   "project": {
83     "_links": {
84       "environments": {
85         "href": "/api/v2/projects/my-project/environments",
86         "type": "application/json"
87       },
88       "self": {
89         "href": "/api/v2/projects/my-project",
90         "type": "application/json"
91       }
92     },
93     "_id": "57be1db38b75bf0772d11383",
94     "key": "project-key-123abc",
95     "includeInSnippetByDefault": true,
96     "name": "My Project",
97     "tags": [
98       "ops"
99     ],
100     "defaultClientSideAvailability": {
101       "usingMobileKey": true,
102       "usingEnvironmentId": true
103     },
104     "_access": {
105       "denied": [
106         {
107           "action": "action",
108           "reason": {
109             "effect": "allow"
110           }
111         }
112       ],
113       "allowed": [
114         {
115           "action": "action",
116           "reason": {
117             "effect": "allow"
118           }
119         }
120       ]
121     },
122     "defaultReleasePipelineKey": "defaultReleasePipelineKey",
123     "environments": {
124       "items": [
125         {
126           "_links": {
127             "self": {
128               "href": "/api/v2/projects/my-project/environments/my-environment",
129               "type": "application/json"
130             }
131           },
132           "_id": "57be1db38b75bf0772d11384",
133           "key": "environment-key-123abc",
134           "name": "My Environment",
135           "apiKey": "sdk-xxx",
136           "mobileKey": "mob-xxx",
137           "color": "F5A623",
138           "defaultTtl": 5,
139           "secureMode": true,
140           "defaultTrackEvents": false,
141           "requireComments": true,
142           "confirmChanges": true,
143           "tags": [
144             "ops"
145           ],
146           "critical": true,
147           "approvalSettings": {
148             "required": true,
149             "bypassApprovalsForPendingChanges": false,
150             "minNumApprovals": 1,
151             "canReviewOwnRequest": false,
152             "canApplyDeclinedChanges": true,
153             "serviceKind": "launchdarkly",
154             "serviceConfig": {
155               "key": "value"
156             },
157             "requiredApprovalTags": [
158               "require-approval"
159             ],
160             "autoApplyApprovedChanges": true,
161             "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"
162           }
163         }
164       ],
165       "_links": {
166         "key": {}
167       },
168       "totalCount": 2
169     }
170   },
171   "environments": [
172     {
173       "_links": {
174         "self": {
175           "href": "/api/v2/projects/my-project/environments/my-environment",
176           "type": "application/json"
177         }
178       },
179       "_id": "57be1db38b75bf0772d11384",
180       "key": "environment-key-123abc",
181       "name": "My Environment",
182       "apiKey": "sdk-xxx",
183       "mobileKey": "mob-xxx",
184       "color": "F5A623",
185       "defaultTtl": 5,
186       "secureMode": true,
187       "defaultTrackEvents": false,
188       "requireComments": true,
189       "confirmChanges": true,
190       "tags": [
191         "ops"
192       ],
193       "critical": true,
194       "approvalSettings": {
195         "required": true,
196         "bypassApprovalsForPendingChanges": false,
197         "minNumApprovals": 1,
198         "canReviewOwnRequest": false,
199         "canApplyDeclinedChanges": true,
200         "serviceKind": "launchdarkly",
201         "serviceConfig": {
202           "key": "value"
203         },
204         "requiredApprovalTags": [
205           "require-approval"
206         ],
207         "autoApplyApprovedChanges": true,
208         "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"
209       },
210       "resourceApprovalSettings": {
211         "key": {
212           "required": true,
213           "bypassApprovalsForPendingChanges": false,
214           "minNumApprovals": 1,
215           "canReviewOwnRequest": false,
216           "canApplyDeclinedChanges": true,
217           "serviceKind": "launchdarkly",
218           "serviceConfig": {
219             "key": "value"
220           },
221           "requiredApprovalTags": [
222             "require-approval"
223           ],
224           "autoApplyApprovedChanges": true,
225           "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"
226         }
227       }
228     }
229   ],
230   "flag": {
231     "name": "My Flag",
232     "kind": "boolean",
233     "key": "flag-key-123abc",
234     "_version": 1,
235     "creationDate": 1000000,
236     "variations": [
237       {
238         "value": true,
239         "_id": "e432f62b-55f6-49dd-a02f-eb24acf39d05"
240       },
241       {
242         "value": false,
243         "_id": "a00bf58d-d252-476c-b915-15a74becacb4"
244       }
245     ],
246     "temporary": true,
247     "tags": [
248       "example-tag"
249     ],
250     "_links": {
251       "parent": {
252         "href": "/api/v2/flags/my-project",
253         "type": "application/json"
254       },
255       "self": {
256         "href": "/api/v2/flags/my-project/my-flag",
257         "type": "application/json"
258       }
259     },
260     "customProperties": {
261       "key": {
262         "name": "Jira issues",
263         "value": [
264           "is-123",
265           "is-456"
266         ]
267       }
268     },
269     "archived": false,
270     "description": "This flag controls the example widgets",
271     "clientSideAvailability": {
272       "usingMobileKey": true,
273       "usingEnvironmentId": true
274     },
275     "maintainerId": "569f183514f4432160000007",
276     "_maintainer": {
277       "_links": {
278         "self": {
279           "href": "/api/v2/members/569f183514f4432160000007",
280           "type": "application/json"
281         }
282       },
283       "_id": "569f183514f4432160000007",
284       "role": "admin",
285       "email": "ariel@acme.com",
286       "firstName": "Ariel",
287       "lastName": "Flores"
288     },
289     "archivedDate": 1000000,
290     "defaults": {
291       "onVariation": 0,
292       "offVariation": 1
293     },
294     "includeInSnippet": true
295   },
296   "resource": {
297     "kind": "flag",
298     "flag": {
299       "name": "My Flag",
300       "kind": "boolean",
301       "key": "flag-key-123abc",
302       "_version": 1,
303       "creationDate": 1000000,
304       "variations": [
305         {
306           "value": true,
307           "_id": "e432f62b-55f6-49dd-a02f-eb24acf39d05"
308         },
309         {
310           "value": false,
311           "_id": "a00bf58d-d252-476c-b915-15a74becacb4"
312         }
313       ],
314       "temporary": true,
315       "tags": [
316         "example-tag"
317       ],
318       "_links": {
319         "parent": {
320           "href": "/api/v2/flags/my-project",
321           "type": "application/json"
322         },
323         "self": {
324           "href": "/api/v2/flags/my-project/my-flag",
325           "type": "application/json"
326         }
327       },
328       "customProperties": {
329         "key": {
330           "name": "Jira issues",
331           "value": [
332             "is-123",
333             "is-456"
334           ]
335         }
336       },
337       "archived": false,
338       "description": "This flag controls the example widgets",
339       "maintainerId": "569f183514f4432160000007",
340       "_maintainer": {
341         "_links": {
342           "self": {
343             "href": "/api/v2/members/569f183514f4432160000007",
344             "type": "application/json"
345           }
346         },
347         "_id": "569f183514f4432160000007",
348         "role": "admin",
349         "email": "ariel@acme.com",
350         "firstName": "Ariel",
351         "lastName": "Flores"
352       },
353       "archivedDate": 1000000,
354       "defaults": {
355         "onVariation": 0,
356         "offVariation": 1
357       },
358       "includeInSnippet": true
359     },
360     "segment": {
361       "name": "Example segment",
362       "tags": [
363         "testing"
364       ],
365       "creationDate": 1000000,
366       "lastModifiedDate": 1000000,
367       "key": "segment-key-123abc",
368       "_links": {
369         "key": {}
370       },
371       "rules": [
372         {
373           "clauses": [
374             {
375               "attribute": "email",
376               "op": "endsWith",
377               "values": [
378                 ".edu"
379               ],
380               "negate": false,
381               "_id": "12ab3c45de678910fab12345"
382             }
383           ],
384           "_id": "1234a56b7c89d012345e678f"
385         }
386       ],
387       "version": 1,
388       "deleted": false,
389       "generation": 1,
390       "description": "Bundle our sample customers together",
391       "included": [
392         "user-key-123abc"
393       ],
394       "excluded": [
395         "user-key-123abc"
396       ],
397       "includedContexts": [
398         {}
399       ],
400       "excludedContexts": [
401         {}
402       ],
403       "_access": {
404         "denied": [
405           {
406             "action": "action",
407             "reason": {
408               "effect": "allow"
409             }
410           }
411         ],
412         "allowed": [
413           {
414             "action": "action",
415             "reason": {
416               "effect": "allow"
417             }
418           }
419         ]
420       },
421       "_flags": [
422         {
423           "name": "Example flag",
424           "key": "flag-key-123abc"
425         }
426       ],
427       "unbounded": false,
428       "unboundedContextKind": "unboundedContextKind",
429       "_external": "amplitude",
430       "_externalLink": "https://analytics.amplitude.com/org/1234/cohort/123abc",
431       "_importInProgress": false
432     },
433     "aiConfig": {
434       "key": "aiconfig-key-123abc",
435       "name": "AI Config 1"
436     }
437   }
438 }

Get an approval request by approval request ID.

Expanding approval response

LaunchDarkly supports the expand query param to include additional fields in the response, with the following fields:

environments includes the environments the approval request relates to
flag includes the flag the approval request belongs to
project includes the project the approval request belongs to
resource includes details on the resource (flag or segment) the approval request relates to

For example, expand=project,flag includes the project and flag fields in the response.

Path parameters

idstringRequired

The approval request ID

Query parameters

expandstringOptional

A comma-separated list of fields to expand in the response. Supported fields are explained above.

Response

Approval request response

_idstring

The ID of this approval request

_versioninteger

Version of the approval request

creationDatelong

Timestamp of when the approval request was created

serviceKindstring

The approval service for this request. May be LaunchDarkly or an external approval service, such as ServiceNow or JIRA.

reviewStatusenum

Current status of the review of this approval request

Allowed values:

allReviewslist of objects

An array of individual reviews of this approval request

notifyMemberIdslist of strings

An array of member IDs. These members are notified to review the approval request.

statusenum

Current status of the approval request

Allowed values:

instructionslist of maps from strings to any

List of instructions in semantic patch format to be applied to the feature flag

conflictslist of objects

Details on any conflicting approval requests

_linksmap from strings to any

The location and content type of related resources

requestorIdstring or null

The ID of the member who requested the approval

descriptionstring or null

A human-friendly name for the approval request

appliedDatelong or null

Timestamp of when the approval request was applied

appliedByMemberIdstring or null

The member ID of the member who applied the approval request

appliedByServiceTokenIdstring or null

The service token ID of the service token which applied the approval request

executionDatelong or null

Timestamp for when instructions will be executed

operatingOnIdstring or null

ID of scheduled change to edit or delete

integrationMetadataobject or null

Details about the object in an external service corresponding to this approval request, such as a ServiceNow change request or a JIRA ticket, if an external approval service is being used

sourceobject or null

Details about the source feature flag, if copied

customWorkflowMetadataobject or null

Details about the custom workflow, if this approval request is part of a custom workflow

resourceIdstring or null

String representation of a resource

approvalSettingsobject or null

The settings for this approval

projectobject or null

Project the approval request belongs to

environmentslist of objects or null

List of environments the approval impacts

flagobject or null

Flag the approval request belongs to

resourceobject or null

Resource the approval request belongs to

Get approval request

Expanding approval response

Path parameters

Headers

Query parameters

Response

Errors