v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB

User settings

Get flag setting for user

Get a single flag setting for a user by flag key. <br /><br />The _value is the flag variation that the user receives. The setting indicates whether you've explicitly targeted a user to receive a particular variation. For example, if you have turned off a feature flag for a user, this setting will be false. The example response indicates that the user Abbie_Braun has the sort.order flag enabled.

get/api/v2/users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey}

Path parameters

projectKeystring string required

The project key

environmentKeystring string required

The environment key

userKeystring string required

The user key

featureFlagKeystring string required

The feature flag key

Response

User flag settings response

_linksobject required

The location and content type of related resources.

_valuestring required

The value of the flag variation that the user receives. If there is no defined default rule, this is null.

settingstring required

Whether the user is explicitly targeted to receive a particular variation. The setting is false if you have turned off a feature flag for a user. It is null if you haven't assigned that user to a specific variation.

Example response

{
  "_links": {
    "sort.order": {
      "href": "/api/v2/users/lacuna/production/Abbie_Braun/flags/sort.order",
      "type": "application/json"
    }
  },
  "_value": "true",
  "setting": "null",
  "reason": {
    "kind": "OFF",
    "ruleIndex": 3,
    "ruleID": "1234567890",
    "prerequisiteKey": "someotherflagkey",
    "inExperiment": true,
    "errorKind": "USER_NOT_SPECIFIED"
  }
}