Skip to main content

Approvals API

Approval workflows require changes to be reviewed before being applied. Useful for production environment changes.

Create Approval Request

POST /v1/approvals

Auth: JWT (Owner, Admin, Developer)

Request

{
"flag_id": "flag-uuid",
"env_id": "production-uuid",
"change_type": "enable",
"payload": {
"enabled": true,
"percentage_rollout": 5000
}
}
FieldTypeRequiredDescription
flag_idstringYesTarget flag ID
env_idstringYesTarget environment ID
change_typestringYesType of change (e.g., enable, update_state)
payloadobjectNoThe flag state to apply when approved

Response 201 Created

{
"id": "uuid",
"org_id": "uuid",
"requestor_id": "uuid",
"flag_id": "flag-uuid",
"env_id": "production-uuid",
"change_type": "enable",
"payload": {"enabled": true, "percentage_rollout": 5000},
"status": "pending",
"created_at": "2026-04-01T00:00:00Z",
"updated_at": "2026-04-01T00:00:00Z"
}

List Approval Requests

GET /v1/approvals?status=pending&limit=50&offset=0

Auth: JWT (All roles)

Query Parameters

ParameterDefaultDescription
statusallFilter by status: pending, approved, rejected, applied
limit50Max results (capped at 100)
offset0Pagination offset

Get Approval Request

GET /v1/approvals/{approvalID}

Auth: JWT (All roles)

Response 200 OK

Returns the full approval request object.


Review Approval

Approve or reject a pending approval request.

POST /v1/approvals/{approvalID}/review

Auth: JWT (Owner, Admin)

Request

{
"action": "approve",
"note": "Looks good, approved for production rollout"
}
FieldTypeRequiredDescription
actionstringYesapprove or reject
notestringNoReview comment

Behavior

  • Only pending requests can be reviewed
  • The requestor cannot review their own request
  • On approve: the payload is applied as a flag state update, status becomes applied, and an audit entry flag.approved_change_applied is created
  • On reject: status becomes rejected

Response 200 OK

Returns the updated approval request with reviewer information.

Approval Statuses

StatusDescription
pendingWaiting for review
approvedApproved (transitional)
rejectedRejected by reviewer
appliedApproved and changes applied