LaunchDarkly REST API
LaunchDarkly DocsSign in
HomeAPI ReferenceSDKsContext Plugin
User settings

Get flag setting for user

Deprecated

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

Get a single flag setting for a user by flag key. 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.

Authorization

ApiKey read, write
Authorization<token>

In: header

Scope: read, write

Path Parameters

projectKey*string

The project key

Formatstring
environmentKey*string

The environment key

Formatstring
userKey*string

The user key

Formatstring
featureFlagKey*string

The feature flag key

Formatstring

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2/users/string/string/string/flags/string"
{  "_links": {    "sort.order": {      "href": "/api/v2/users/lacuna/production/Abbie_Braun/flags/sort.order",      "type": "application/json"    }  },  "_value": "true",  "setting": "null",  "reason": "{\"kind\": \"RULE_MATCH\"}"}

List flag settings for user GET

Get the current flag settings for a given user. <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 and the `alternate.page` flag disabled, and that the user has not been explicitly targeted to receive a particular variation.

Update flag settings for user PUT

Enable or disable a feature flag for a user based on their key. Omitting the `setting` attribute from the request body, or including a `setting` of `null`, erases the current setting for a user. If you previously patched the flag, and the patch included the user's data, LaunchDarkly continues to use that data. If LaunchDarkly has never encountered the user's key before, it calculates the flag values based on the user key alone.