Skip to content

Flags API

Manage feature flags programmatically.

List Flags

http
GET /v1/flags

Response:

json
{
  "data": [
    {
      "id": "flag_123",
      "key": "new-checkout",
      "description": "New checkout flow",
      "enabled": true,
      "createdAt": "2024-01-15T10:00:00Z"
    }
  ]
}

Get Flag

http
GET /v1/flags/:key

Response:

json
{
  "data": {
    "id": "flag_123",
    "key": "new-checkout",
    "description": "New checkout flow",
    "enabled": true,
    "rules": [...],
    "createdAt": "2024-01-15T10:00:00Z",
    "updatedAt": "2024-01-20T15:30:00Z"
  }
}

Create Flag

http
POST /v1/flags

Request:

json
{
  "key": "new-checkout",
  "description": "New checkout flow",
  "enabled": false,
  "rules": [
    {
      "type": "percentage",
      "percentage": 10
    }
  ]
}

Update Flag

http
PATCH /v1/flags/:key

Request:

json
{
  "enabled": true,
  "rules": [
    {
      "type": "percentage",
      "percentage": 50
    }
  ]
}

Delete Flag

http
DELETE /v1/flags/:key

Evaluate Flag

http
POST /v1/flags/:key/evaluate

Request:

json
{
  "userId": "user-123",
  "attributes": {
    "plan": "pro",
    "country": "US"
  }
}

Response:

json
{
  "data": {
    "enabled": true,
    "reason": "rule_match"
  }
}

Built with VitePress