v7

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-015406837.0 KB

Client

Get a single feature flag

Gets all the client data for a single flag. Contains the exact same information about a flag as the /api/client/features endpoint does, but only contains data about the specified flag. All SDKs should use /api/client/features

get/api/client/features/{featureName}

Path parameters

featureNamestring required

Response

clientFeatureSchema

namestring required

The unique name of a feature flag. Is validated to be URL safe on creation

typestring

What kind of feature flag is this. Refer to the documentation on feature flag types for more information

descriptionstring nullable

A description of the flag

enabledboolean required

Whether the feature flag is enabled for the current API key or not. This is ANDed with the evaluation results of the strategies list, so if this is false, the evaluation result will always be false

staleboolean

If this is true Unleash believes this feature flag has been active longer than Unleash expects a flag of this type to be active

impressionDataboolean nullable

Set to true if SDKs should trigger impression events when this flag is evaluated

projectstring

Which project this feature flag belongs to

Example response

{
  "name": "new.payment.flow.stripe",
  "type": "release",
  "description": "No variants here",
  "enabled": true,
  "project": "new.payment.flow",
  "strategies": [
    {
      "id": "6b5157cb-343a-41e7-bfa3-7b4ec3044840",
      "name": "flexibleRollout",
      "title": "Gradual Rollout 25-Prod",
      "featureName": "myAwesomeFeature",
      "sortOrder": 9999,
      "segments": [
        1,
        2
      ],
      "constraints": [
        {
          "contextName": "appName",
          "operator": "IN",
          "values": [
            "my-app",
            "my-other-app"
          ],
          "value": "my-app"
        }
      ],
      "variants": [
        {
          "name": "blue_group",
          "weightType": "fix",
          "stickiness": "custom.context.field",
          "payload": {
            "type": "json",
            "value": "{\"color\": \"red\"}"
          }
        }
      ]
    }
  ],
  "variants": [
    {
      "name": "blue_group",
      "weightType": "variable",
      "stickiness": "custom.context.field",
      "payload": {
        "type": "json",
        "value": "{\"color\": \"red\"}"
      },
      "overrides": [
        {
          "contextName": "userId",
          "values": [
            "red",
            "blue"
          ]
        }
      ]
    }
  ],
  "dependencies": [
    {
      "feature": "parent_feature",
      "variants": [
        "variantA",
        "variantB"
      ]
    }
  ]
}

All 5 operations