v1

latestOpenAPI 3.0.3MIT2026-07-26104113247.1 KB
Get Flag Definitions

Get Feature Flag Definitions

Retrieve all enabled feature flag definitions for the authenticated project. Returns complete flag metadata including rulesets, variants, and rollout configurations.

get/flags/definitions

Path parameters

project_idinteger required

Query parameters

tokenstring

Your project token

Response

Success

Example response

{
  "flags": [
    {
      "id": "flag_abc123",
      "name": "New Checkout Flow",
      "key": "new_checkout_flow",
      "status": "enabled",
      "project_id": 12345,
      "workspace_id": 67890,
      "ruleset": {
        "variants": [
          {
            "key": "treatment",
            "is_sticky": true,
            "split": 0.5
          }
        ],
        "rollout": [
          {
            "rollout_percentage": 0.8,
            "cohort_hash": "cohort_abc123",
            "runtime_evaluation_rule": {
              "platform": "web"
            },
            "runtime_evaluation_definition": {
              "platform": "web"
            },
            "variant_splits": {
              "control": 0.5,
              "treatment": 0.5
            },
            "variant_override": {
              "key": "treatment"
            }
          }
        ],
        "test": {
          "users": {
            "qa_user_1": "treatment",
            "qa_user_2": "control"
          }
        }
      },
      "context": "device_id",
      "experiment_id": "exp_123",
      "is_experiment_active": true
    }
  ]
}