Get approval request

GET
/api/v2/approval-requests/:id

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:

  • 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.

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
Allowed values: approveddeclinedpending

Current status of the review of this approval request

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
Allowed values: pendingcompletedfailedscheduled

Current status of the approval request

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

requestorIdstringOptional

The ID of the member who requested the approval

descriptionstringOptional

A human-friendly name for the approval request

appliedDatelongOptional

Timestamp of when the approval request was applied

appliedByMemberIdstringOptional

The member ID of the member who applied the approval request

appliedByServiceTokenIdstringOptional

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

executionDatelongOptional

Timestamp for when instructions will be executed

operatingOnIdstringOptional

ID of scheduled change to edit or delete

integrationMetadataobjectOptional

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

sourceobjectOptional

Details about the source feature flag, if copied

customWorkflowMetadataobjectOptional

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

resourceIdstringOptional

String representation of a resource

approvalSettingsobjectOptional

The settings for this approval

projectobjectOptional

Project the approval request belongs to

environmentslist of objectsOptional

List of environments the approval impacts

flagobjectOptional

Flag the approval request belongs to

resourceobjectOptional

Resource the approval request belongs to

Errors

Get approval request for a flag
Built with