List approval requests

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

Get all approval requests.

Filtering approvals

LaunchDarkly supports the filter query param for filtering, with the following fields:

• notifyMemberIds filters for only approvals that are assigned to a member in the specified list. For example: filter=notifyMemberIds anyOf ["memberId1", "memberId2"].
• requestorId filters for only approvals that correspond to the ID of the member who requested the approval. For example: filter=requestorId equals 457034721476302714390214.
• resourceId filters for only approvals that correspond to the the specified resource identifier. For example: filter=resourceId equals proj/my-project:env/my-environment:flag/my-flag.
• resourceKind filters for only approvals that correspond to the specified resource kind. For example: filter=resourceKind equals flag. Currently, flag, segment, and aiConfig resource kinds are supported.
• reviewStatus filters for only approvals which correspond to the review status in the specified list. The possible values are approved, declined, and pending. For example: filter=reviewStatus anyOf ["pending", "approved"].
• status filters for only approvals which correspond to the status in the specified list. The possible values are pending, scheduled, failed, and completed. For example: filter=status anyOf ["pending", "scheduled"].

You can also apply multiple filters at once. For example, setting filter=projectKey equals my-project, reviewStatus anyOf ["pending","approved"] matches approval requests which correspond to the my-project project key, and a review status of either pending or approved.

Expanding approval response

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

• flag includes the flag the approval request belongs to
• project includes the project the approval request belongs to
• environments includes the environments the approval request relates to

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

GET /api/v2/approval-requests

List approval requests

cURL

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/approval-requests \
  --header 'Authorization: <api-key>'

200

{
  "items": [
    {
      "_id": "12ab3c45de678910abc12345",
      "_version": 1,
      "creationDate": "1654104600000",
      "serviceKind": "launchdarkly",
      "reviewStatus": "pending",
      "allReviews": [
        {
          "_id": "12ab3c45de678910abc12345",
          "kind": "approve",
          "creationDate": "1653606981113",
          "comment": "Approved!",
          "memberId": "12ab3c45de678910abc12345",
          "serviceTokenId": "12ab3c45de678910abc12345"
        }
      ],
      "notifyMemberIds": [
        "1234a56b7c89d012345e678f"
      ],
      "status": "pending",
      "instructions": "[{\"kind\": \"turnFlagOn\"}]",
      "conflicts": [
        {
          "instruction": {},
          "reason": "<string>"
        }
      ],
      "_links": {},
      "requestorId": "12ab3c45de678910abc12345",
      "description": "example: request approval from someone",
      "appliedDate": "1654104600000",
      "appliedByMemberId": "1234a56b7c89d012345e678f",
      "appliedByServiceTokenId": "1234a56b7c89d012345e678f",
      "executionDate": "1654104600000",
      "operatingOnId": "12ab3c45de678910abc12345",
      "integrationMetadata": {
        "externalId": "<string>",
        "externalStatus": {
          "display": "<string>",
          "value": "<string>"
        },
        "externalUrl": "<string>",
        "lastChecked": 123
      },
      "source": {
        "key": "source-flag-key-123abc",
        "version": 1
      },
      "customWorkflowMetadata": {
        "name": "Example workflow name",
        "stage": {
          "index": 0,
          "name": "Stage 1"
        }
      },
      "resourceId": "<string>",
      "approvalSettings": {
        "required": true,
        "bypassApprovalsForPendingChanges": false,
        "minNumApprovals": 1,
        "canReviewOwnRequest": false,
        "canApplyDeclinedChanges": true,
        "serviceKind": "launchdarkly",
        "serviceConfig": {},
        "requiredApprovalTags": [
          "require-approval"
        ],
        "autoApplyApprovedChanges": true,
        "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"
      },
      "project": {
        "_links": {
          "environments": {
            "href": "/api/v2/projects/my-project/environments",
            "type": "application/json"
          },
          "self": {
            "href": "/api/v2/projects/my-project",
            "type": "application/json"
          }
        },
        "_id": "57be1db38b75bf0772d11383",
        "key": "project-key-123abc",
        "includeInSnippetByDefault": true,
        "name": "My Project",
        "tags": [
          "ops"
        ],
        "defaultClientSideAvailability": {
          "usingMobileKey": true,
          "usingEnvironmentId": true
        },
        "_access": {
          "denied": [
            {
              "action": "<string>",
              "reason": {
                "effect": "allow",
                "resources": [
                  "proj/*:env/*;qa_*:/flag/*"
                ],
                "notResources": [
                  "<string>"
                ],
                "actions": [
                  "*"
                ],
                "notActions": [
                  "<string>"
                ],
                "role_name": "<string>"
              }
            }
          ],
          "allowed": [
            {
              "action": "<string>",
              "reason": {
                "effect": "allow",
                "resources": [
                  "proj/*:env/*;qa_*:/flag/*"
                ],
                "notResources": [
                  "<string>"
                ],
                "actions": [
                  "*"
                ],
                "notActions": [
                  "<string>"
                ],
                "role_name": "<string>"
              }
            }
          ]
        },
        "defaultReleasePipelineKey": "<string>",
        "environments": {
          "items": [
            {
              "_links": {
                "self": {
                  "href": "/api/v2/projects/my-project/environments/my-environment",
                  "type": "application/json"
                }
              },
              "_id": "57be1db38b75bf0772d11384",
              "key": "environment-key-123abc",
              "name": "My Environment",
              "apiKey": "sdk-xxx",
              "mobileKey": "mob-xxx",
              "color": "F5A623",
              "defaultTtl": 5,
              "secureMode": true,
              "defaultTrackEvents": false,
              "requireComments": true,
              "confirmChanges": true,
              "tags": [
                "ops"
              ],
              "critical": true,
              "_access": {
                "denied": [
                  {
                    "action": "<string>",
                    "reason": {
                      "effect": "allow",
                      "resources": [
                        "proj/*:env/*;qa_*:/flag/*"
                      ],
                      "notResources": [
                        "<string>"
                      ],
                      "actions": [
                        "*"
                      ],
                      "notActions": [
                        "<string>"
                      ],
                      "role_name": "<string>"
                    }
                  }
                ],
                "allowed": [
                  {
                    "action": "<string>",
                    "reason": {
                      "effect": "allow",
                      "resources": [
                        "proj/*:env/*;qa_*:/flag/*"
                      ],
                      "notResources": [
                        "<string>"
                      ],
                      "actions": [
                        "*"
                      ],
                      "notActions": [
                        "<string>"
                      ],
                      "role_name": "<string>"
                    }
                  }
                ]
              },
              "approvalSettings": {
                "required": true,
                "bypassApprovalsForPendingChanges": false,
                "minNumApprovals": 1,
                "canReviewOwnRequest": false,
                "canApplyDeclinedChanges": true,
                "serviceKind": "launchdarkly",
                "serviceConfig": {},
                "requiredApprovalTags": [
                  "require-approval"
                ],
                "autoApplyApprovedChanges": true,
                "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"
              },
              "resourceApprovalSettings": {}
            }
          ],
          "_links": {},
          "totalCount": 2
        }
      },
      "environments": [
        {
          "_links": {
            "self": {
              "href": "/api/v2/projects/my-project/environments/my-environment",
              "type": "application/json"
            }
          },
          "_id": "57be1db38b75bf0772d11384",
          "key": "environment-key-123abc",
          "name": "My Environment",
          "apiKey": "sdk-xxx",
          "mobileKey": "mob-xxx",
          "color": "F5A623",
          "defaultTtl": 5,
          "secureMode": true,
          "defaultTrackEvents": false,
          "requireComments": true,
          "confirmChanges": true,
          "tags": [
            "ops"
          ],
          "critical": true,
          "_access": {
            "denied": [
              {
                "action": "<string>",
                "reason": {
                  "effect": "allow",
                  "resources": [
                    "proj/*:env/*;qa_*:/flag/*"
                  ],
                  "notResources": [
                    "<string>"
                  ],
                  "actions": [
                    "*"
                  ],
                  "notActions": [
                    "<string>"
                  ],
                  "role_name": "<string>"
                }
              }
            ],
            "allowed": [
              {
                "action": "<string>",
                "reason": {
                  "effect": "allow",
                  "resources": [
                    "proj/*:env/*;qa_*:/flag/*"
                  ],
                  "notResources": [
                    "<string>"
                  ],
                  "actions": [
                    "*"
                  ],
                  "notActions": [
                    "<string>"
                  ],
                  "role_name": "<string>"
                }
              }
            ]
          },
          "approvalSettings": {
            "required": true,
            "bypassApprovalsForPendingChanges": false,
            "minNumApprovals": 1,
            "canReviewOwnRequest": false,
            "canApplyDeclinedChanges": true,
            "serviceKind": "launchdarkly",
            "serviceConfig": {},
            "requiredApprovalTags": [
              "require-approval"
            ],
            "autoApplyApprovedChanges": true,
            "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"
          },
          "resourceApprovalSettings": {}
        }
      ],
      "flag": {
        "name": "My Flag",
        "kind": "boolean",
        "key": "flag-key-123abc",
        "_version": 1,
        "creationDate": "1494437420312",
        "variations": [
          {
            "_id": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
            "value": true
          },
          {
            "_id": "a00bf58d-d252-476c-b915-15a74becacb4",
            "value": false
          }
        ],
        "temporary": true,
        "tags": [
          "example-tag"
        ],
        "_links": {
          "parent": {
            "href": "/api/v2/flags/my-project",
            "type": "application/json"
          },
          "self": {
            "href": "/api/v2/flags/my-project/my-flag",
            "type": "application/json"
          }
        },
        "customProperties": "{\"jira.issues\":{\"name\":\"Jira issues\",\"value\":[\"is-123\",\"is-456\"]}}",
        "archived": false,
        "description": "This flag controls the example widgets",
        "includeInSnippet": true,
        "clientSideAvailability": "{\"usingMobileKey\":true,\"usingEnvironmentId\":false}",
        "maintainerId": "569f183514f4432160000007",
        "_maintainer": {
          "_links": {
            "self": {
              "href": "/api/v2/members/569f183514f4432160000007",
              "type": "application/json"
            }
          },
          "_id": "569f183514f4432160000007",
          "role": "admin",
          "email": "[e-mail]",
          "firstName": "Ariel",
          "lastName": "Flores"
        },
        "archivedDate": "1494437420312",
        "defaults": "{\"onVariation\":0,\"offVariation\":1}"
      },
      "resource": {
        "kind": "flag",
        "aiConfig": {
          "key": "aiconfig-key-123abc",
          "name": "AI Config 1"
        },
        "experiment": {
          "key": "experiment-key-123abc",
          "name": "My Experiment",
          "_access": {
            "denied": [
              {
                "action": "<string>",
                "reason": {
                  "effect": "allow",
                  "resources": [
                    "proj/*:env/*;qa_*:/flag/*"
                  ],
                  "notResources": [
                    "<string>"
                  ],
                  "actions": [
                    "*"
                  ],
                  "notActions": [
                    "<string>"
                  ],
                  "role_name": "<string>"
                }
              }
            ],
            "allowed": [
              {
                "action": "<string>",
                "reason": {
                  "effect": "allow",
                  "resources": [
                    "proj/*:env/*;qa_*:/flag/*"
                  ],
                  "notResources": [
                    "<string>"
                  ],
                  "actions": [
                    "*"
                  ],
                  "notActions": [
                    "<string>"
                  ],
                  "role_name": "<string>"
                }
              }
            ]
          }
        },
        "flag": {
          "name": "My Flag",
          "kind": "boolean",
          "key": "flag-key-123abc",
          "_version": 1,
          "creationDate": "1494437420312",
          "variations": [
            {
              "_id": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
              "value": true
            },
            {
              "_id": "a00bf58d-d252-476c-b915-15a74becacb4",
              "value": false
            }
          ],
          "temporary": true,
          "tags": [
            "example-tag"
          ],
          "_links": {
            "parent": {
              "href": "/api/v2/flags/my-project",
              "type": "application/json"
            },
            "self": {
              "href": "/api/v2/flags/my-project/my-flag",
              "type": "application/json"
            }
          },
          "customProperties": "{\"jira.issues\":{\"name\":\"Jira issues\",\"value\":[\"is-123\",\"is-456\"]}}",
          "archived": false,
          "description": "This flag controls the example widgets",
          "includeInSnippet": true,
          "clientSideAvailability": "{\"usingMobileKey\":true,\"usingEnvironmentId\":false}",
          "maintainerId": "569f183514f4432160000007",
          "_maintainer": {
            "_links": {
              "self": {
                "href": "/api/v2/members/569f183514f4432160000007",
                "type": "application/json"
              }
            },
            "_id": "569f183514f4432160000007",
            "role": "admin",
            "email": "[e-mail]",
            "firstName": "Ariel",
            "lastName": "Flores"
          },
          "archivedDate": "1494437420312",
          "defaults": "{\"onVariation\":0,\"offVariation\":1}"
        },
        "segment": {
          "name": "Example segment",
          "tags": [
            "testing"
          ],
          "creationDate": "1654104600000",
          "lastModifiedDate": "1654104600000",
          "key": "segment-key-123abc",
          "_links": {},
          "rules": [
            {
              "_id": "1234a56b7c89d012345e678f",
              "clauses": [
                {
                  "_id": "12ab3c45de678910fab12345",
                  "attribute": "email",
                  "negate": false,
                  "op": "endsWith",
                  "values": [
                    ".edu"
                  ]
                }
              ]
            }
          ],
          "version": 1,
          "deleted": false,
          "generation": 123,
          "description": "Bundle our sample customers together",
          "included": [
            "user-key-123abc"
          ],
          "excluded": [
            "user-key-123abc"
          ],
          "includedContexts": [
            {
              "values": [
                "<string>"
              ],
              "contextKind": "<string>"
            }
          ],
          "excludedContexts": [
            {
              "values": [
                "<string>"
              ],
              "contextKind": "<string>"
            }
          ],
          "_access": {
            "denied": [
              {
                "action": "<string>",
                "reason": {
                  "effect": "allow",
                  "resources": [
                    "proj/*:env/*;qa_*:/flag/*"
                  ],
                  "notResources": [
                    "<string>"
                  ],
                  "actions": [
                    "*"
                  ],
                  "notActions": [
                    "<string>"
                  ],
                  "role_name": "<string>"
                }
              }
            ],
            "allowed": [
              {
                "action": "<string>",
                "reason": {
                  "effect": "allow",
                  "resources": [
                    "proj/*:env/*;qa_*:/flag/*"
                  ],
                  "notResources": [
                    "<string>"
                  ],
                  "actions": [
                    "*"
                  ],
                  "notActions": [
                    "<string>"
                  ],
                  "role_name": "<string>"
                }
              }
            ]
          },
          "_flags": [
            {
              "name": "Example flag",
              "key": "flag-key-123abc",
              "_links": {},
              "_site": {
                "href": "<string>",
                "type": "<string>"
              }
            }
          ],
          "unbounded": false,
          "unboundedContextKind": "<string>",
          "_unboundedMetadata": {
            "envId": "<string>",
            "segmentId": "<string>",
            "version": 123,
            "includedCount": 123,
            "excludedCount": 123,
            "lastModified": 123,
            "deleted": true
          },
          "_external": "amplitude",
          "_externalLink": "https://analytics.amplitude.com/org/1234/cohort/123abc",
          "_importInProgress": false
        }
      }
    }
  ],
  "totalCount": 1,
  "_links": {}
}

Authorizations

Authorization · string · header · required

Query Parameters

filter · string<string>

A comma-separated list of filters. Each filter is of the form field operator value. Supported fields are explained above.

expand · string<string>

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

limit · integer<int64>

The number of approvals to return. Defaults to 20. Maximum limit is 200.

offset · integer<int64>

Where to start in the list. 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

200

application/json

Approval request collection response

items · object[] · required

An array of approval requests

Show child attributes

totalCount · integer · required

Total number of approval requests

Example:

1

_links · object · required

The location and content type of related resources

Show child attributes